Class BufferChunkSource

Generate chunks from a fixed buffer.

Hierarchy

KnownSizeChunkSource
- BufferChunkSource

Implements

ChunkSource

Index

Constructors

Properties

chunkSize final finalChunkSize totalSize

Methods

getChunk getPayload listChunks

Constructors

constructor

new BufferChunkSource(input, opts?): BufferChunkSource
Parameters
- input: Uint8Array
- opts: ChunkOptions = {}
Returns BufferChunkSource
Overrides KnownSizeChunkSource.constructor
- Defined in serve/chunk-source/buffer.ts:5

Properties

`Protected` `Readonly`chunkSize

chunkSize: number

`Protected` `Readonly`final

final: number

`Protected` `Readonly`finalChunkSize

finalChunkSize: number

`Protected` `Readonly`totalSize

totalSize: number

Methods

getChunk

getChunk(i): Promise<undefined | Chunk>
Generate a chunk on-demand.
Parameters
- i: number
  Chunk number, starting from zero.
Returns Promise<undefined | Chunk>
Promise that resolves to requested chunk, or undefined if out of range.
Implementation of ChunkSource.getChunk
Inherited from KnownSizeChunkSource.getChunk
- Defined in serve/chunk-source/common.ts:56

`Protected`getPayload

getPayload(i, offset, chunkSize): Promise<Uint8Array>
Parameters
- i: number
- offset: number
- chunkSize: number
Returns Promise<Uint8Array>
Overrides KnownSizeChunkSource.getPayload
- Defined in serve/chunk-source/buffer.ts:9

listChunks

listChunks(): AsyncIterable<Chunk, any, any>
Generate chunks sequentially.

Returns AsyncIterable<Chunk, any, any>
AsyncIterable of chunks in order.
Implementation of ChunkSource.listChunks
Inherited from KnownSizeChunkSource.listChunks
- Defined in serve/chunk-source/common.ts:49