Class ArchiveReader

Generic utility for parsing tar entries from a stream of octets via AsyncUint8ArrayIterator

Implements

ArchiveContext
AsyncIterableIterator<ArchiveEntry>

Index

Constructors

Accessors

globalPaxHeaders source

Methods

[asyncIterator] next readAllEntries tryLoadNextEntryContentChunk withInput

Constructors

constructor

new ArchiveReader(bufferIterator: AsyncUint8ArrayIterator): ArchiveReader
Parameters
- bufferIterator: AsyncUint8ArrayIterator
Returns ArchiveReader
- Defined in archive/archive-reader.ts:66

Accessors

globalPaxHeaders

get globalPaxHeaders(): TarHeader[]
Returns TarHeader[]
Implementation of ArchiveContext.globalPaxHeaders
- Defined in archive/archive-reader.ts:82

source

get source(): AsyncUint8ArrayLike
Returns AsyncUint8ArrayLike
Implementation of ArchiveContext.source
- Defined in archive/archive-reader.ts:78

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterableIterator<ArchiveEntry>
Returns AsyncIterableIterator<ArchiveEntry>
Implementation of AsyncIterableIterator.[asyncIterator]
- Defined in archive/archive-reader.ts:74

next

next(): Promise<IteratorResult<ArchiveEntry, any>>
Returns Promise<IteratorResult<ArchiveEntry, any>>
Implementation of AsyncIterableIterator.next
- Defined in archive/archive-reader.ts:96

readAllEntries

readAllEntries(): Promise<ArchiveEntry[]>
Returns Promise<ArchiveEntry[]>
- Defined in archive/archive-reader.ts:86

tryLoadNextEntryContentChunk

tryLoadNextEntryContentChunk(
entry: ArchiveEntryLike,
): Promise<null | Uint8Array<ArrayBufferLike>>
Parameters
- entry: ArchiveEntryLike
Returns Promise<null | Uint8Array<ArrayBufferLike>>
Implementation of ArchiveContext.tryLoadNextEntryContentChunk
- Defined in archive/archive-reader.ts:106

`Static`withInput

withInput(
input: AsyncUint8ArrayIteratorInput,
options?: Partial<AsyncUint8ArrayIteratorOptions>,
): ArchiveReader
Parameters
- input: AsyncUint8ArrayIteratorInput
- Optionaloptions: Partial<AsyncUint8ArrayIteratorOptions>
Returns ArchiveReader
- Defined in archive/archive-reader.ts:70