Class BundleReader

Index

Methods

open has keys entries entry byLabel readBytes readBlob dispose

Methods

`Static`open

open(source: BundleSource): Promise<BundleReader>
Open an archive: reads the trailing footer, then the TOC.
Parameters
- source: BundleSource
Returns Promise<BundleReader>
- Defined in src/assets/bundles/bundle_reader.ts:31

has

has(key: string): boolean
Whether key exists in this bundle.
Parameters
- key: string
Returns boolean
- Defined in src/assets/bundles/bundle_reader.ts:46

keys

keys(): string[]
All entry keys.

Returns string[]
- Defined in src/assets/bundles/bundle_reader.ts:51

entries

entries(): readonly BundleEntry[]
The raw TOC entries (read-only).

Returns readonly BundleEntry[]
- Defined in src/assets/bundles/bundle_reader.ts:56

entry

entry(key: string): BundleEntry | undefined
The entry metadata for key, or undefined.
Parameters
- key: string
Returns BundleEntry | undefined
- Defined in src/assets/bundles/bundle_reader.ts:61

byLabel

byLabel(label: string): string[]
Keys of every entry tagged with label.
Parameters
- label: string
Returns string[]
- Defined in src/assets/bundles/bundle_reader.ts:66

readBytes

readBytes(key: string): Promise<ArrayBuffer>
Read and decompress the bytes for key. Concurrent calls share one fetch.
Parameters
- key: string
Returns Promise<ArrayBuffer>
- Defined in src/assets/bundles/bundle_reader.ts:71

readBlob

readBlob(key: string, mime?: string): Promise<Blob>
Read key as a Blob (e.g. for createImageBitmap).
Parameters
- key: string
- Optionalmime: string
Returns Promise<Blob>
- Defined in src/assets/bundles/bundle_reader.ts:86

dispose

dispose(): void
Release the underlying source (file handle / cached buffer).

Returns void
- Defined in src/assets/bundles/bundle_reader.ts:104