Interface EventStoreQuery<K, V, QueryExt>

Query APIs for an event store.

interface EventStoreQuery {
    entries(options?): SyncOrAsyncGenerator<[K, V], K[]>;
    keys(options?): SyncOrAsyncGenerator<K, K[]>;
    values(options?): SyncOrAsyncGenerator<V, K[]>;
}

Type Parameters

K = ContentId
V = unknown
QueryExt extends object = NonNullable<unknown>

Hierarchy

EventStoreQuery
- ReadonlyEventStore

Index

Methods

entries keys values

Methods

entries

entries(options?): SyncOrAsyncGenerator<[K, V], K[]>
Queries entries by given criteria.
Parameters
- Optional options: EventStoreQueryOptions<K> & QueryExt
Returns SyncOrAsyncGenerator<[K, V], K[]>
- Defined in collections/src/eventstore.ts:26

keys

keys(options?): SyncOrAsyncGenerator<K, K[]>
Queries event keys by given criteria.
Parameters
- Optional options: EventStoreQueryOptions<K> & QueryExt
Returns SyncOrAsyncGenerator<K, K[]>
- Defined in collections/src/eventstore.ts:29

values

values(options?): SyncOrAsyncGenerator<V, K[]>
Queries events by given criteria.
Parameters
- Optional options: EventStoreQueryOptions<K> & QueryExt
Returns SyncOrAsyncGenerator<V, K[]>
- Defined in collections/src/eventstore.ts:32

Generated using TypeDoc