Class DagEventStore<K, V>

An EventStore implementation that stores a direct-acyclic graph of content-addressable events.

Type Parameters

K extends StringEquatable<K> = ContentId
V = unknown

Hierarchy

BaseDagEventStore<K, V, EventStoreMetaQueryOptions<K>>
- DagEventStore

Implements

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

Index

Constructors

constructor

new DagEventStore<K, V>(__namedParameters?): DagEventStore<K, V>
Type Parameters
- K extends StringEquatable<K> = ContentId<number, number>
- V = unknown
Parameters
- __namedParameters: DagEventStoreOptions<K, V> = {}
Returns DagEventStore<K, V>
Overrides BaseDagEventStore.constructor
- Defined in collections/src/eventstore/dag.ts:23

Properties

`Protected` `Readonly` currentEventDeps

currentEventDeps: [K, V][] = []

Cache of event parents during a put/validate operation.

`Protected` `Readonly` data

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

`Protected` `Readonly` getEventMeta

getEventMeta: ((event) => undefined | EventMeta<K>) = ...

Type declaration

- (event): undefined | EventMeta<K>
- Returns given event metadata.
  Parameters
  - event: V
  Returns undefined | EventMeta<K>

`Protected` `Readonly` headSet

headSet: {
    add(value, options?): unknown;
    addMany?(keys, options?): MaybeAsyncIterableIterator<undefined | Error>;
    delete(value, options?): unknown;
    deleteMany?(keys, options?): MaybeAsyncIterableIterator<undefined | Error>;
    has(value, options?): MaybePromise<boolean>;
    hasMany?(keys, options?): MaybeAsyncIterableIterator<boolean>;
    updateMany?(keys, options?): MaybeAsyncIterableIterator<undefined | Error>;
}

Type declaration

add:function
- add(value, options?): unknown
- Adds an entry to the set. Returns MaybePromise<unknown> to be compatible with ES Set.
  Parameters
  - value: K
  - Optional options: AbortOptions
  Returns unknown
  - Defined in collections/src/set.ts:18
addMany?:function
- addMany(keys, options?): MaybeAsyncIterableIterator<undefined | Error>
- Adds the values with given keys to the set.
  Parameters
  - keys: Iterable<K>
  - Optional options: AbortOptions
  Returns MaybeAsyncIterableIterator<undefined | Error>
  - Defined in collections/src/set.ts:36
delete:function
- delete(value, options?): unknown
- Deletes an entry from the set. Returns MaybePromise<unknown> to be compatible with ES Set.
  Parameters
  - value: K
  - Optional options: AbortOptions
  Returns unknown
  - Defined in collections/src/set.ts:12
deleteMany?:function
- deleteMany(keys, options?): MaybeAsyncIterableIterator<undefined | Error>
- Deletes the values with given keys.
  Parameters
  - keys: Iterable<K>
  - Optional options: AbortOptions
  Returns MaybeAsyncIterableIterator<undefined | Error>
  - Defined in collections/src/set.ts:30
has:function
- has(value, options?): MaybePromise<boolean>
- Returns whether a value exists in the set.
  Parameters
  - value: K
  - Optional options: AbortOptions
  Returns MaybePromise<boolean>
  - Defined in collections/src/set.ts:6
hasMany?:function
- hasMany(keys, options?): MaybeAsyncIterableIterator<boolean>
- Checks if given keys exist in the set.
  Parameters
  - keys: Iterable<K>
  - Optional options: AbortOptions
  Returns MaybeAsyncIterableIterator<boolean>
  - Defined in collections/src/set.ts:24
updateMany?:function
- updateMany(keys, options?): MaybeAsyncIterableIterator<undefined | Error>
- Adds or deletes given list of keys.
  Parameters
  - keys: Iterable<readonly [K, undefined | boolean]>
  - Optional options: AbortOptions
  Returns MaybeAsyncIterableIterator<undefined | Error>
  - Defined in collections/src/set.ts:42

`Protected` `Readonly` keyCodec

keyCodec: Codec<K, string>

`Protected` `Readonly` queryPageSize

queryPageSize: number = DEFAULT_BATCH_SIZE

`Protected` useCache

useCache: boolean = false

Set to true to use cache.

Accessors

heads

get heads(): {
has(value, options?): MaybePromise<boolean>;
}
The head event keys.

Returns {
has(value, options?): MaybePromise<boolean>;
}
- has:function
  - has(value, options?): MaybePromise<boolean>
  - Returns whether a value exists in the set.
    Parameters
    - value: K
    - Optional options: AbortOptions
    Returns MaybePromise<boolean>
    - Defined in collections/src/set.ts:6
- Defined in collections/src/eventstore/dag.ts:35

Methods

[asyncIterator]

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

entries

entries(options?): AsyncGenerator<[K, V], K[], unknown>
Queries entries by given criteria.
Parameters
- Optional options: EventStoreQueryOptions<K> & EventStoreMetaQueryOptions<K>
Returns AsyncGenerator<[K, V], K[], unknown>
Implementation of EventStore.entries
Overrides BaseDagEventStore.entries
- Defined in collections/src/eventstore/dag.ts:40

`Protected` entriesForKeys

entriesForKeys(keys, options?): AsyncGenerator<[K, V], any, unknown>
Parameters
- keys: K[]
- Optional options: AbortOptions
Returns AsyncGenerator<[K, V], any, unknown>
Inherited from BaseDagEventStore.entriesForKeys
- 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
Inherited from BaseDagEventStore.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
Inherited from BaseDagEventStore.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
Inherited from BaseDagEventStore.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
Inherited from BaseDagEventStore.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
Inherited from BaseDagEventStore.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> & EventStoreMetaQueryOptions<K>
Returns SyncOrAsyncGenerator<K, K[]>
Implementation of EventStore.keys
Inherited from BaseDagEventStore.keys
- Defined in collections/src/eventstore/base/base.ts:101

`Protected` prePut

prePut(value, options?): Promise<V>
Hook to do extra processing before putting an event value to store.
Parameters
- value: V
- Optional options: AbortOptions
Returns Promise<V>
Overrides BaseDagEventStore.prePut
- Defined in collections/src/eventstore/dag.ts:112

`Protected` predecessors

predecessors(keys, visited, options?): AsyncIterableIterator<[key: K, value: V, level: number]>
Traverses the graph of events from given keys and returns the max level.
Parameters
- keys: readonly K[]
- visited: MaybeAsyncMap<K, number>
- Optional options: EventStoreQueryOptions<K> & EventStoreMetaQueryOptions<K>
Returns AsyncIterableIterator<[key: K, value: V, level: number]>
- Defined in collections/src/eventstore/dag.ts:131

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
Inherited from BaseDagEventStore.put
- Defined in collections/src/eventstore/base/dag.ts:83

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
Inherited from BaseDagEventStore.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
Inherited from BaseDagEventStore.validate
- Defined in collections/src/eventstore/base/dag.ts:34

values

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

Class DagEventStore<K, V>

Type Parameters

K extends StringEquatable<K> = ContentId

V = unknown

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

K extends StringEquatable<K> = ContentId<number, number>

V = unknown

Parameters

__namedParameters: DagEventStoreOptions<K, V> = {}

Returns DagEventStore<K, V>

Properties

Protected Readonly currentEventDeps

Protected Readonly data

Protected Readonly getEventMeta

Type declaration

Parameters

event: V

Returns undefined | EventMeta<K>

Protected Readonly headSet

Type declaration

add:function

Parameters

value: K

Optional options: AbortOptions

Returns unknown

addMany?:function

Parameters

keys: Iterable<K>

Optional options: AbortOptions

Returns MaybeAsyncIterableIterator<undefined | Error>

delete:function

Parameters

value: K

Optional options: AbortOptions

Returns unknown

deleteMany?:function

Parameters

keys: Iterable<K>

Optional options: AbortOptions

Returns MaybeAsyncIterableIterator<undefined | Error>

has:function

Parameters

value: K

Optional options: AbortOptions

Returns MaybePromise<boolean>

hasMany?:function

Parameters

keys: Iterable<K>

Optional options: AbortOptions

Returns MaybeAsyncIterableIterator<boolean>

updateMany?:function

Parameters

keys: Iterable<readonly [K, undefined | boolean]>

Optional options: AbortOptions

Returns MaybeAsyncIterableIterator<undefined | Error>

Protected Readonly keyCodec

Protected Readonly queryPageSize

Protected useCache

Accessors

heads

Returns { has(value, options?): MaybePromise<boolean>; }

has:function

Parameters

value: K

Optional options: AbortOptions

Returns MaybePromise<boolean>

Methods

[asyncIterator]

Returns AsyncIterableIterator<[K, V]>

entries

Parameters

`Protected` `Readonly` currentEventDeps

`Protected` `Readonly` data

`Protected` `Readonly` getEventMeta

`Protected` `Readonly` headSet

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Protected` `Readonly` keyCodec

`Protected` `Readonly` queryPageSize

`Protected` useCache

Returns {
has(value, options?): MaybePromise<boolean>;
}

`Optional` options: AbortOptions

`Optional` options: EventStoreQueryOptions<K> & EventStoreMetaQueryOptions<K>

`Protected` entriesForKeys

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: EventStoreQueryOptions<K> & EventStoreMetaQueryOptions<K>

`Protected` prePut

`Optional` options: AbortOptions

`Protected` predecessors

`Optional` options: EventStoreQueryOptions<K> & EventStoreMetaQueryOptions<K>

`Optional` options: EventStorePutOptions

`Optional` options: EventStorePutOptions

`Optional` options: AbortOptions

`Optional` options: EventStoreQueryOptions<K> & EventStoreMetaQueryOptions<K>