prorm API Reference
    Preparing search index...

    Interface ScrollOptions

    Args for scroll().

    interface ScrollOptions {
        consistency?: number | "all" | "majority" | "quorum";
        timeout?: number;
        filter?: {};
        limit?: number;
        offset?: string | number;
        withPayload?: boolean | string[] | {} | {};
        withVector?: boolean | string[];
    }

    Hierarchy (View Summary)

    Index
    consistency? timeout? filter? limit? offset? withPayload? withVector?
    consistency?: number | "all" | "majority" | "quorum"

    Read-consistency requirement.

    timeout?: number

    Per-request timeout override, in seconds.

    filter?: {}

    Restrict results to points matching this filter.

    limit?: number

    Page size. Default: 10.

    offset?: string | number

    Start ID to read from (the nextPageOffset of a prior page, for pagination).

    withPayload?: boolean | string[] | {} | {}

    Which payload fields to attach. Default: true (all).

    withVector?: boolean | string[]

    Which vector(s) to attach. Default: false.

    Settings
    Member Visibility

    On This Page
    Properties