Class OREntityProjection<Id, V>

Observed-removed entity event projection.

Type Parameters

Id extends ToString = ContentId
V = unknown

Implements

EntityProjection<Id, V>

Index

Constructors

Properties

acquireLock getEventKey

Methods

reduce validate

Constructors

constructor

new OREntityProjection<Id, V>(getEventKey?, acquireLock?): OREntityProjection<Id, V>
Type Parameters
- Id extends ToString = ContentId<number, number>
- V = unknown
Parameters
- getEventKey: ((event, options?) => MaybePromise<Id>) = getCID
  Function to get key of event.
  - - (event, options?): MaybePromise<Id>
    - Function to get key of event.
      
      Parameters
      event: EntityEvent<Id, V>
      Optional options: AbortOptions
      Returns MaybePromise<Id>
- acquireLock: ((key, options?) => MaybePromise<LockGuard>) = ...
  Function to acquire a lock on an event key.
  - - (key, options?): MaybePromise<LockGuard>
    - Function to acquire a lock on an event key.
      
      Parameters
      key: Id
      Optional options: AbortOptions
      Returns MaybePromise<LockGuard>
Returns OREntityProjection<Id, V>
- Defined in crdt/src/mutation/event.ts:11

Properties

`Protected` `Readonly` acquireLock

acquireLock: ((key, options?) => MaybePromise<LockGuard>) = ...

Type declaration

- (key, options?): MaybePromise<LockGuard>
- Function to acquire a lock on an event key.
  Parameters
  - key: Id
  - Optional options: AbortOptions
  Returns MaybePromise<LockGuard>

`Protected` `Readonly` getEventKey

getEventKey: ((event, options?) => MaybePromise<Id>) = getCID

Type declaration

- (event, options?): MaybePromise<Id>
- Function to get key of event.
  Parameters
  - event: EntityEvent<Id, V>
  - Optional options: AbortOptions
  Returns MaybePromise<Id>

Methods

reduce

reduce(state, event, options?): Promise<EntityStore<Id, V>>
Parameters
- state: EntityStore<Id, V>
- event: EntityEvent<Id, V>
- Optional options: AbortOptions
Returns Promise<EntityStore<Id, V>>
Implementation of EntityProjection.reduce
- Defined in crdt/src/mutation/event.ts:20

validate

validate(state, event, options?): Promise<undefined | Error>
Parameters
- state: ReadonlyEntityStore<Id, V>
- event: EntityEvent<Id, V>
- Optional options: AbortOptions
Returns Promise<undefined | Error>
Implementation of EntityProjection.validate
- Defined in crdt/src/mutation/event.ts:74

Generated using TypeDoc