Interface EventStore<K, V, QueryExt>

An append-only event store.

interface EventStore {
    entries(options?): SyncOrAsyncGenerator<[K, V], K[]>;
    get(key, options?): MaybePromise<undefined | V>;
    getKey(value, options?): MaybePromise<K>;
    getMany(keys, options?): MaybeAsyncIterableIterator<undefined | V>;
    has(key, options?): MaybePromise<boolean>;
    hasMany(keys, options?): MaybeAsyncIterableIterator<boolean>;
    keys(options?): SyncOrAsyncGenerator<K, K[]>;
    put(value, options?): MaybePromise<K>;
    putMany(values, options?): MaybeAsyncIterableIterator<[key: K, error?: Error]>;
    validate(value, options?): MaybePromise<undefined | Error>;
    values(options?): SyncOrAsyncGenerator<V, K[]>;
}

Type Parameters

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

Hierarchy

ReadonlyEventStore<K, V, QueryExt>
AppendOnlyAutoKeyMap<K, V>
AutoKeyMapPutBatch<K, V>
- EventStore

Implemented by

Index

Methods

entries get getKey getMany has hasMany keys put putMany validate 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[]>
Inherited from ReadonlyEventStore.entries
- Defined in collections/src/eventstore.ts:26

get

get(key, options?): MaybePromise<undefined | V>
Gets a value by key from the map.
Parameters
- key: K
- Optional options: AbortOptions
Returns MaybePromise<undefined | V>
Inherited from AppendOnlyAutoKeyMap.get
- Defined in collections/src/map.ts:7

getKey

getKey(value, options?): MaybePromise<K>
Gets the key of given value.
Parameters
- value: V
- Optional options: AbortOptions
Returns MaybePromise<K>
Inherited from AppendOnlyAutoKeyMap.getKey
- Defined in collections/src/map.ts:25

getMany

getMany(keys, options?): MaybeAsyncIterableIterator<undefined | V>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<undefined | V>
Inherited from ReadonlyEventStore.getMany
- Defined in collections/src/map.ts:47

has

has(key, options?): MaybePromise<boolean>
Returns whether a key exists in the map.
Parameters
- key: K
- Optional options: AbortOptions
Returns MaybePromise<boolean>
Inherited from AppendOnlyAutoKeyMap.has
- Defined in collections/src/map.ts:10

hasMany

hasMany(keys, options?): MaybeAsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<boolean>
Inherited from ReadonlyEventStore.hasMany
- Defined in collections/src/set.ts:24

keys

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

put

put(value, options?): MaybePromise<K>
Puts given value and returns its key.
Parameters
- value: V
- Optional options: EventStorePutOptions
Returns MaybePromise<K>
Overrides AppendOnlyAutoKeyMap.put
- Defined in collections/src/eventstore.ts:10

putMany

putMany(values, options?): MaybeAsyncIterableIterator<[key: K, error?: Error]>
Puts given list of values and returns their keys.
Parameters
- values: Iterable<V>
- Optional options: EventStorePutOptions
Returns MaybeAsyncIterableIterator<[key: K, error?: Error]>
Overrides AutoKeyMapPutBatch.putMany
- Defined in collections/src/eventstore.ts:12

validate

validate(value, options?): MaybePromise<undefined | Error>
Validates given event and returns any error.
Parameters
- value: V
- Optional options: AbortOptions
Returns MaybePromise<undefined | Error>
Inherited from ReadonlyEventStore.validate
- Defined in collections/src/eventstore.ts:20

values

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

Interface EventStore<K, V, QueryExt>

Type Parameters

K = ContentId

V = unknown

QueryExt extends object = NonNullable<unknown>

Hierarchy

Implemented by

Index

Methods

Methods

entries

Parameters

Optional options: EventStoreQueryOptions<K> & QueryExt

Returns SyncOrAsyncGenerator<[K, V], K[]>

get

Parameters

key: K

Optional options: AbortOptions

Returns MaybePromise<undefined | V>

getKey

Parameters

value: V

Optional options: AbortOptions

Returns MaybePromise<K>

getMany

Parameters

keys: Iterable<K>

Optional options: AbortOptions

Returns MaybeAsyncIterableIterator<undefined | V>

has

Parameters

key: K

Optional options: AbortOptions

Returns MaybePromise<boolean>

hasMany

Parameters

keys: Iterable<K>

Optional options: AbortOptions

Returns MaybeAsyncIterableIterator<boolean>

keys

Parameters

Optional options: EventStoreQueryOptions<K> & QueryExt

Returns SyncOrAsyncGenerator<K, K[]>

put

Parameters

value: V

Optional options: EventStorePutOptions

Returns MaybePromise<K>

putMany

Parameters

values: Iterable<V>

Optional options: EventStorePutOptions

Returns MaybeAsyncIterableIterator<[key: K, error?: Error]>

validate

Parameters

value: V

Optional options: AbortOptions

Returns MaybePromise<undefined | Error>

values

Parameters

Optional options: EventStoreQueryOptions<K> & QueryExt

Returns SyncOrAsyncGenerator<V, K[]>

Settings

Member Visibility

Theme

On This Page

`Optional` options: EventStoreQueryOptions<K> & QueryExt

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: EventStoreQueryOptions<K> & QueryExt

`Optional` options: EventStorePutOptions

`Optional` options: EventStorePutOptions

`Optional` options: AbortOptions

`Optional` options: EventStoreQueryOptions<K> & QueryExt