Documentation

    Interface QueryEventsParams

    Return list of events for a specified query criteria.

    interface QueryEventsParams {
        cursor?: null | EventId;
        limit?: null | number;
        order?: null | "ascending" | "descending";
        query: SuiEventFilter;
        signal?: AbortSignal;
    }
    Index

    Properties

    cursor? limit? order? query signal?

    Properties

    cursor?: null | EventId

    optional paging cursor

    limit?: null | number

    maximum number of items per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.

    order?: null | "ascending" | "descending"

    query result ordering, default to false (ascending order), oldest record first.

    query: SuiEventFilter

    The event query criteria. See Event filter documentation for examples.

    signal?: AbortSignal

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR