NDNts

    Interface ChunkSource

    An object that can generate chunks.

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

    Implemented by

    Index

    Properties

    close? getChunk? listChunks

    Properties

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

    Generate a chunk on-demand.

    Type declaration

      • (i: number): Promise<undefined | Chunk>

      • Parameters

        • i: number

          Chunk number, starting from zero.

        Returns Promise<undefined | Chunk>

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

    listChunks: () => AsyncIterable<Chunk>

    Generate chunks sequentially.

    Type declaration

      • (): AsyncIterable<Chunk>

      • Returns AsyncIterable<Chunk>

        AsyncIterable of chunks in order.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR