Class BaseMapEventStore<K, V, QueryExt>`Abstract`

An abstract EventStore that stores events in an append-only auto-keyed map. One of entries or keys query functions must be overridden in subclass, as by default they refer to each other.

Type Parameters

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

Hierarchy

BaseMapEventStore
- BaseDagEventStore

Implements

EventStore<K, V, QueryExt>
AsyncIterable<[K, V]>

Index

Constructors

Properties

data queryPageSize

Methods

[asyncIterator] entries entriesForKeys get getKey getMany has hasMany keys prePut put putMany validate values

Constructors

constructor

new BaseMapEventStore<K, V, QueryExt>(data, queryPageSize?): BaseMapEventStore<K, V, QueryExt>
Type Parameters
- K = ContentId<number, number>
- V = unknown
- QueryExt extends object = {}
Parameters
- data: AppendOnlyAutoKeyMap<K, V> & Partial<AutoKeyMapBatch<K, V>>
- queryPageSize: number = DEFAULT_BATCH_SIZE
Returns BaseMapEventStore<K, V, QueryExt>
- Defined in collections/src/eventstore/base/base.ts:16

Properties

`Protected` `Readonly` data

data: AppendOnlyAutoKeyMap<K, V> & Partial<AutoKeyMapBatch<K, V>>

`Protected` `Readonly` queryPageSize

queryPageSize: number = DEFAULT_BATCH_SIZE

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<[K, V]>
Returns AsyncIterableIterator<[K, V]>
Implementation of AsyncIterable.[asyncIterator]
- Defined in collections/src/eventstore/base/base.ts:119

entries

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

`Protected` entriesForKeys

entriesForKeys(keys, options?): AsyncGenerator<[K, V], any, unknown>
Parameters
- keys: K[]
- Optional options: AbortOptions
Returns AsyncGenerator<[K, V], any, unknown>
- Defined in collections/src/eventstore/base/base.ts:123

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>
Implementation of EventStore.get
- Defined in collections/src/eventstore/base/base.ts:38

getKey

getKey(value, options?): MaybePromise<K>
Gets the key of given value.
Parameters
- value: V
- Optional options: AbortOptions
Returns MaybePromise<K>
Implementation of EventStore.getKey
- Defined in collections/src/eventstore/base/base.ts:34

getMany

getMany(keys, options?): AsyncIterableIterator<undefined | V>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | V>
Implementation of EventStore.getMany
- Defined in collections/src/eventstore/base/base.ts:42

has

has(key, options?): MaybePromise<boolean>
Returns whether a key exists in the map.
Parameters
- key: K
- Optional options: AbortOptions
Returns MaybePromise<boolean>
Implementation of EventStore.has
- Defined in collections/src/eventstore/base/base.ts:46

hasMany

hasMany(keys, options?): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns AsyncIterableIterator<boolean>
Implementation of EventStore.hasMany
- Defined in collections/src/eventstore/base/base.ts:50

keys

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

`Protected` prePut

prePut(value, _options?): MaybePromise<V>
Hook to do extra processing before putting an event value to store.
Parameters
- value: V
- Optional _options: AbortOptions
Returns MaybePromise<V>
- Defined in collections/src/eventstore/base/base.ts:23

put

put(value, options?): Promise<K>
Puts given value and returns its key.
Parameters
- value: V
- Optional options: EventStorePutOptions
Returns Promise<K>
Implementation of EventStore.put
- Defined in collections/src/eventstore/base/base.ts:54

putMany

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

validate

validate(value, options?): Promise<undefined | Error>
Validates given event and returns any error.
Parameters
- value: V
- Optional options: AbortOptions
Returns Promise<undefined | Error>
Implementation of EventStore.validate
- Defined in collections/src/eventstore/base/base.ts:27

values

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

Generated using TypeDoc