Class FileChunkSource

Generate chunks from a file.

Remarks

Warning: modifying the file while FileChunkSource is active may cause undefined behavior.

Implements

ChunkSource

Index

Constructors

Methods

close getChunk listChunks

Constructors

constructor

new FileChunkSource(
path: string,
opts?: FileChunkSource.Options,
): FileChunkSource
Parameters
- path: string
- opts: FileChunkSource.Options = {}
Returns FileChunkSource
- Defined in serve/chunk-source/file.ts:32

Methods

close

close(): Promise<void>
Returns Promise<void>
Implementation of ChunkSource.close
- Defined in serve/chunk-source/file.ts:55

getChunk

getChunk(i: number): 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
- Defined in serve/chunk-source/file.ts:50

listChunks

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

Returns AsyncIterable<Chunk>
AsyncIterable of chunks in order.
Implementation of ChunkSource.listChunks
- Defined in serve/chunk-source/file.ts:44