Class EventStore<T>

A light state management pattern allowing storage, retrieval, and monitoring of state.

Type Parameters

T extends Object

Implements

IEventStore<T>

Index

Constructors

Methods

GetLedger GetState ObservableAt Redo SetState Undo

Constructors

constructor

new EventStore<T extends Object>(state: T): EventStore<T>
Type Parameters
- T extends Object
Parameters
- state: T
Returns EventStore<T>
- Defined in src/Patterns/EventStore/EventStore.ts:19

Methods

GetLedger

GetLedger(): Transaction<any>[]
Returns a collection of all the transactions which resulted in the current state

Returns Transaction<any>[]
Implementation of IEventStore.GetLedger
- Defined in src/Patterns/EventStore/EventStore.ts:68

GetState

GetState<V>(member?: string | MemberLambda<T, V>): any
Returns a copy of the current state
Type Parameters
- V
Parameters
- Optionalmember: string | MemberLambda<T, V>
Returns any
Implementation of IEventStore.GetState
- Defined in src/Patterns/EventStore/EventStore.ts:23

ObservableAt

ObservableAt<V>(member?: string | MemberLambda<T, V>): Observable<V>
Returns an observable which can be subscribed to in order to act on ANY state changes within the store
Type Parameters
- V
Parameters
- Optionalmember: string | MemberLambda<T, V>
Returns Observable<V>
Implementation of IEventStore.ObservableAt
- Defined in src/Patterns/EventStore/EventStore.ts:59

Redo

Redo(): Result<undefined | T>
Reverses the void on the newest voided transaction excluding any voided transaction that follows a non-voided one (Once state is set, prior voided transactions cannot be reversed)

Returns Result<undefined | T>
Implementation of IEventStore.Redo
- Defined in src/Patterns/EventStore/EventStore.ts:87

SetState

SetState<V>(
memberOrState: string | T | MemberLambda<T, V>,
state?: T,
): Result<T | V>
Update the current state of the entire store
Type Parameters
- V
Parameters
- memberOrState: string | T | MemberLambda<T, V>
- Optionalstate: T
  state to set at a root level
Returns Result<T | V>
Implementation of IEventStore.SetState
- Defined in src/Patterns/EventStore/EventStore.ts:32

Undo

Undo(): Result<undefined | T>
Voids the most recent (non-voided) transaction, returning the stores value to the previous 'from' state

Returns Result<undefined | T>
Implementation of IEventStore.Undo
- Defined in src/Patterns/EventStore/EventStore.ts:72