Documentation
    Preparing search index...

    Interface QueryEventsParams

    Return list of events for a specified query criteria.

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

    Properties

    cursor? limit? order? query signal?

    Properties

    cursor?: EventId | null

    optional paging cursor

    limit?: number | null

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

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

    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