@opscogs/octools
    Preparing search index...

    Interface RecordsEnvelope<T>

    Records whose keys follow the item schema, with an honest cap.

    interface RecordsEnvelope<T = unknown> {
        count: number;
        next_cursor?: string;
        records: T[];
        resumable?: boolean;
        source?: SourceRef;
        stop_reason?: string;
        total_count?: string | number;
        truncated: boolean;
        warnings?: string[];
    }

    Type Parameters

    • T = unknown

    Hierarchy (View Summary)

    Index
    count next_cursor? records resumable? source? stop_reason? total_count? truncated warnings?
    count: number

    Number of records returned, after any cap; equals records.length.

    next_cursor?: string

    Opaque token that resumes the read; present only when resumable.

    records: T[]

    Result records; keys and order follow the item schema.

    resumable?: boolean

    Whether following next_cursor reads more; present only when truncated.

    source?: SourceRef

    Which instance and snapshot answered; left out when unset.

    stop_reason?: string

    Why the read stopped early.

    total_count?: string | number

    Exact size of the full result, as an integer or a decimal string.

    truncated: boolean

    True when a cap, a stop or an interrupted read cut the result short.

    warnings?: string[]

    Non-fatal problems the caller should relay; left out when empty.

    Settings
    Member Visibility

    On This Page
    Properties