A11 TypeScript API - v0.2.1
    Preparing search index...

    Interface ChunkStoreReaderOptions

    Select how a reader follows and retains a ChunkStore sequence.

    interface ChunkStoreReaderOptions {
        maxChunksToRead?: number | null;
        numChunksToBuffer?: number;
        offset?: number;
        ordered?: boolean;
        popChunks?: boolean;
        stickyMimetype?: boolean;
    }
    Index
    maxChunksToRead? numChunksToBuffer? offset? ordered? popChunks? stickyMimetype?
    maxChunksToRead?: number | null

    Stop after this many fragments, or continue to final when null.

    numChunksToBuffer?: number

    Number of fragments to prefetch beyond active callers.

    offset?: number

    Sequence or arrival position at which this cursor begins.

    ordered?: boolean

    Read logical sequence order; false follows ingestion/arrival order.

    popChunks?: boolean

    Clear each payload after reading while retaining its store tombstone.

    stickyMimetype?: boolean

    Expand omitted MIME types from the preceding contiguous chunk.

    Settings
    Member Visibility

    On This Page
    Properties