Skip to content
delta-base docs

QueryEventsOptions

API reference for QueryEventsOptions

@delta-base/toolkit

Type Alias: QueryEventsOptions

Section titled “Type Alias: QueryEventsOptions”

QueryEventsOptions = object

Query parameters for filtering events across streams

Properties

Section titled “Properties”

eventId?

Section titled “eventId?”

optional eventId: string

Filter by specific event ID

fromDate?

Section titled “fromDate?”

optional fromDate: string

Filter by minimum creation date (ISO string)

fromPosition?

Section titled “fromPosition?”

optional fromPosition: number

Filter by minimum global position

includeArchived?

Section titled “includeArchived?”

optional includeArchived: boolean

Whether to include archived events

includeCount?

Section titled “includeCount?”

optional includeCount: boolean

Whether to include total count in results

limit?

Section titled “limit?”

optional limit: number

Maximum number of events to return

offset?

Section titled “offset?”

optional offset: number

Number of events to skip

phase?

Section titled “phase?”

optional phase: number

Filter by event phase

sortBy?

Section titled “sortBy?”

optional sortBy: "globalPosition" | "createdAt" | "streamPosition"

Field to sort results by

sortDirection?

Section titled “sortDirection?”

optional sortDirection: "asc" | "desc"

Direction to sort results

streamId?

Section titled “streamId?”

optional streamId: string

Filter by specific stream ID

toDate?

Section titled “toDate?”

optional toDate: string

Filter by maximum creation date (ISO string)

toPosition?

Section titled “toPosition?”

optional toPosition: number

Filter by maximum global position

transactionId?

Section titled “transactionId?”

optional transactionId: string

Filter by transaction ID

type?

Section titled “type?”

optional type: string | string[]

Filter by event type(s)