Interface ChunkSource

An object that can generate chunks.


  • ChunkSource

Implemented by


close?: (() => void)

Type declaration

    • (): void
    • Returns void

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

Type declaration

    • (i): Promise<undefined | Chunk>
    • Generate a chunk on-demand.


      • i: number

        chunk number, starting from zero.

      Returns Promise<undefined | Chunk>

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

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

Type declaration

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

      Returns AsyncIterable<Chunk>

      an AsyncIterable of chunks in order.

Generated using TypeDoc