bare-bundle

stable

bare-bundle — Application bundle format for JavaScript.

npm i bare-bundle

API

Bundle

`new Bundle(opts?: BundleOptions)`

_Source

Create an empty Bundle, optionally supplying a custom File class to back stored files.

Parameters

Parameter	Type	Default	Description
`opts?`	`BundleOptions`	—	Options; `File` defaults to `MemoryFile`.

`addons: string[]`

_Source

The keys of files in the bundle that are native addons.

`assets: string[]`

_Source

The keys of files in the bundle that are non-JavaScript assets.

`Bundle.from(value: string | Buffer | Bundle): Bundle`

_Source

Coerce value — a serialized bundle string, a Buffer, or an existing Bundle — into a Bundle.

Parameters

Parameter	Type	Default	Description
`value`	`string` \| `Buffer` \| `Bundle`	—	The serialized bundle string or buffer to parse, or an existing `Bundle`.

Returns Bundle — The parsed Bundle, or value itself if it is already a Bundle.

Throws

INVALID_BUNDLE_HEADER — the serialized header is not valid JSON.

`Bundle.isBundle(value: unknown): value is Bundle`

_Source

Check whether value is a Bundle.

Parameters

Parameter	Type	Default	Description
`value`	`unknown`	—	The value to check.

Returns value is Bundle — true if value is a Bundle instance or exposes the bundle kind symbol, false otherwise.

`Bundle.version: number`

_Source

The bundle format version this implementation produces and expects.

`empty(): boolean`

_Source

Check whether the bundle contains no files.

Returns boolean — true if the bundle contains no files, false otherwise.

`exists(key: string): boolean`

_Source

Check whether a file exists at key.

Parameters

Parameter	Type	Default	Description
`key`	`string`	—	The key of the file to look up.

Returns boolean — true if a file exists at key, false otherwise.

`files: Record<string, MemoryFile>`

_Source

The bundle's files, keyed by path, as MemoryFile instances.

`id: string | null`

_Source

An optional identifier for the bundle, or null if unset.

`imports: RecursiveStringObject`

_Source

The bundle's import map, mapping specifiers to file keys.

`keys(): string[]`

_Source

Return the keys of all files in the bundle.

`main: string | null`

_Source

The key of the bundle's entry file, or null if unset.

`mode(key: string): number`

_Source

Return the file mode (permission bits) of the file at key, or 0 if it doesn't exist.

Parameters

Parameter	Type	Default	Description
`key`	`string`	—	The key of the file to look up.

`mount(root: string | URL, opts?: BundleMountOptions): Bundle`

_Source

Return a copy of the bundle with all file keys and import/resolution specifiers rewritten as absolute URLs resolved against root.

Parameters

Parameter	Type	Default	Description
`root`	`string` \| `URL`	—	The base URL (or URL string) to resolve keys and specifiers against.
`opts?`	`BundleMountOptions`	—	Options; `conditions` maps import-map condition names to per-condition roots.

Returns Bundle — A new Bundle with rewritten keys; the original bundle is left unchanged.

`read(key: string): Buffer`

_Source

Return the contents of the file at key as a Buffer, or null if it doesn't exist.

Parameters

Parameter	Type	Default	Description
`key`	`string`	—	The key of the file to read.

`resolutions: RecursiveStringObject`

_Source

The bundle's per-file import resolutions map, used to override the default import map for specific files.

`toBuffer(opts?: BundleToBufferOptions): Buffer`

_Source

Serialize the bundle to a single Buffer containing its header and file contents.

Parameters

Parameter	Type	Default	Description
`opts?`	`BundleToBufferOptions`	—	Options; `indent` defaults to `0` and `shared` to `false`.

`unmount(root: string | URL, opts?: BundleMountOptions): Bundle`

_Source

Return a copy of the bundle with all file keys and import/resolution specifiers rewritten as paths relative to root, reversing mount().

Parameters

Parameter	Type	Default	Description
`root`	`string` \| `URL`	—	The base URL (or URL string) to make keys and specifiers relative to.
`opts?`	`BundleMountOptions`	—	Options; `conditions` maps import-map condition names to per-condition roots.

Returns Bundle — A new Bundle with rewritten keys; the original bundle is left unchanged.

`version: number`

_Source

The bundle format version this implementation produces and expects.

`write(key: string, data: string, opts?: BundleWriteOptions): this`

_Source

Add or replace the file at key with data, optionally marking it as the main entry, an addon, an asset, or aliased in the import map.

Parameters

Parameter	Type	Default	Description
`key`	`string`	—	The key (path) to store the file under.
`data`	`string`	—	The file contents.
`opts?`	`BundleWriteOptions`	—	Options; `main`, `addon`, `asset`, and `executable` default to `false`, and `alias` and `imports` to unset.

Returns this — The bundle itself, for chaining writes.

Throws

TypeError — key is not a string.

MemoryFile

`new MemoryFile(data: string | Buffer, opts?: MemoryFileOptions)`

_Source

Create a MemoryFile from data, optionally marking it executable or setting an explicit mode.

Parameters

Parameter	Type	Default	Description
`data`	`string` \| `Buffer`	—	The file contents; a string is converted to a `Buffer`.
`opts?`	`MemoryFileOptions`	—	Options; `mode` defaults to `0o755` when `executable` is `true`, otherwise `0o644`.

interface MemoryFileOptions {
  executable?: boolean
  mode?: number
}

_Source

`BundleOptions`

interface BundleOptions {
  File?: typeof MemoryFile
}

_Source

`BundleWriteOptions`

interface BundleWriteOptions {
  addon?: boolean
  alias?: string
  asset?: boolean
  executable?: boolean
  imports?: RecursiveStringObject
  main?: boolean
  mode?: number
}

_Source

`BundleMountOptions`

interface BundleMountOptions {
  conditions?: { [condition: string]: string | URL }
}

_Source

`BundleToBufferOptions`

interface BundleToBufferOptions {
  indent?: number
  shared?: boolean
}

_Source

bare-bundle

API

Bundle

`new Bundle(opts?: BundleOptions)`

`addons: string[]`

`assets: string[]`

`Bundle.from(value: string | Buffer | Bundle): Bundle`

`Bundle.isBundle(value: unknown): value is Bundle`

`Bundle.version: number`

`empty(): boolean`

`exists(key: string): boolean`

`files: Record<string, MemoryFile>`

`id: string | null`

`imports: RecursiveStringObject`

`keys(): string[]`

`main: string | null`

`mode(key: string): number`

`mount(root: string | URL, opts?: BundleMountOptions): Bundle`

`read(key: string): Buffer`

`resolutions: RecursiveStringObject`

`toBuffer(opts?: BundleToBufferOptions): Buffer`

`unmount(root: string | URL, opts?: BundleMountOptions): Bundle`

`version: number`

`write(key: string, data: string, opts?: BundleWriteOptions): this`

MemoryFile

`new MemoryFile(data: string | Buffer, opts?: MemoryFileOptions)`

`mode(): number`

`read(): Buffer`

`size(): number`

Types

`MemoryFileOptions`

`BundleOptions`

`BundleWriteOptions`

`BundleMountOptions`

`BundleToBufferOptions`

See also

On this page