Documentation
    Preparing search index...

    Interface ListCheckpointsOptions

    interface ListCheckpointsOptions {
        cursor?: string | null;
        endCheckpoint?: string | number;
        filter?: TransactionFilter | TransactionFilter[];
        limit?: number;
        order?: "ascending" | "descending";
        signal?: AbortSignal;
        startCheckpoint?: string | number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cursor? endCheckpoint? filter? limit? order? signal? startCheckpoint?

    Properties

    cursor?: string | null

    Cursor from a previous page. Pages must be requested with a consistent order.

    endCheckpoint?: string | number

    Exclusive end of the checkpoint range to query. Defaults to the latest indexed checkpoint.

    filter?: TransactionFilter | TransactionFilter[]

    Filter(s) over transaction predicates. A checkpoint matches if it contains a transaction satisfying any of the filters.

    limit?: number
    order?: "ascending" | "descending"

    Order of returned results. Defaults to ascending (oldest first).

    signal?: AbortSignal
    startCheckpoint?: string | number

    Inclusive start of the checkpoint range to query. Defaults to genesis.

    Settings

    Member Visibility

    On This Page

    Properties