Interface ChunkSource

An object that can generate chunks.

interface ChunkSource {
    close?: (() => void);
    getChunk?: ((i) => Promise<undefined | Chunk>);
    listChunks: (() => AsyncIterable<Chunk>);
}

Implemented by

Properties

close? getChunk? listChunks

Properties

Optional close

close?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional getChunk

getChunk?: ((i) => Promise<undefined | Chunk>)

Generate a chunk on-demand.

Type declaration

    • (i): Promise<undefined | Chunk>

    • Parameters

      • i: number

        Chunk number, starting from zero.

      Returns Promise<undefined | Chunk>

Returns

Promise that resolves to requested chunk, or undefined if out of range.

listChunks

listChunks: (() => AsyncIterable<Chunk>)

Generate chunks sequentially.

Type declaration

    • (): AsyncIterable<Chunk>

    • Returns AsyncIterable<Chunk>

Returns

AsyncIterable of chunks in order.

Settings

Member Visibility

Theme

On This Page

closegetChunklistChunks