Class ArchiveReader

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

Hierarchy

ArchiveReader

Implements

ArchiveContext
AsyncIterableIterator<TarEntry>

Index

Constructors

Accessors

globalPaxHeaders source

Methods

[asyncIterator] initialize next readAllEntries wrap

Constructors

constructor

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

Accessors

globalPaxHeaders

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

source

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

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<TarEntry>
Returns AsyncIterableIterator<TarEntry>
Implementation of AsyncIterableIterator.__@asyncIterator@1289
- Defined in archive/archive-reader.ts:65

initialize

initialize(): Promise<void>
Returns Promise<void>
- Defined in archive/archive-reader.ts:77

next

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

readAllEntries

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

`Static` wrap

wrap(archiveContent: AsyncUint8ArrayLike | Uint8Array): Promise<ArchiveReader>
Parameters
- archiveContent: AsyncUint8ArrayLike | Uint8Array
Returns Promise<ArchiveReader>
- Defined in archive/archive-reader.ts:55

Generated using TypeDoc