Skip to main content

QueryEventsParams

@iota/iota-sdk

@iota/iota-sdk / client / QueryEventsParams

Interface: QueryEventsParams

Defined in: sdk/typescript/src/client/types/params.ts:456

Return list of events for a specified query criteria.

Properties​

cursor?​

optional cursor?: EventId | null

Defined in: sdk/typescript/src/client/types/params.ts:464

optional paging cursor

limit?​

optional limit?: number | null

Defined in: sdk/typescript/src/client/types/params.ts:466

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

order?​

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

Defined in: sdk/typescript/src/client/types/params.ts:468

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

query​

query: IotaEventFilter

Defined in: sdk/typescript/src/client/types/params.ts:462

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

signal?​

optional signal?: AbortSignal

Defined in: sdk/typescript/src/client/types/params.ts:469