Interface EventStoreQueryOptions<K>

Standard options for a EventStoreQuery query.

interface EventStoreQueryOptions {
    head?: boolean;
    limit?: number;
    signal?: AbortSignal;
    since?: K[];
}

Type Parameters

K

Hierarchy

AbortOptions
- EventStoreQueryOptions

Index

Properties

head? limit? signal? since?

Properties

`Optional` `Readonly` head

head?: boolean

True to return only head events.

`Optional` `Readonly` limit

limit?: number

Maximum number of events to return.

`Optional` signal

signal?: AbortSignal

An optional AbortSignal that can be used to abort an async task.

`Optional` `Readonly` since

since?: K[]

Events after which result shall be returned.

Generated using TypeDoc