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

Properties

ledger state stateObservers

Methods

GetLedger GetState ObservableAt Redo SetState Undo childOf cloneOf getPathFromMemberFunction getStateAtPath getTargetObservers parentOf publishToDependentObservers updateState

Constructors

constructor

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

Properties

`Private` ledger

ledger: Transaction<any>[] = ...

`Private` state

state: T

`Private` stateObservers

stateObservers: Map<string, Observable<any>> = ...

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

ObservableAt

ObservableAt<V>(member?): 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
- Optional member: 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, state?): Result<T | V>
Update the current state of the entire store
Type Parameters
- V
Parameters
- memberOrState: string | T | MemberLambda<T, V>
  state to set at a root level
- Optional state: T
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

`Private` childOf

childOf(parentPath, childPath): boolean
Parameters
- parentPath: string
- childPath: string
Returns boolean
- Defined in src/Patterns/EventStore/EventStore.ts:180

`Private` cloneOf

cloneOf<T>(value): T
Type Parameters
- T
Parameters
- value: T
Returns T
- Defined in src/Patterns/EventStore/EventStore.ts:111

`Private` getPathFromMemberFunction

getPathFromMemberFunction<R>(member?): string
Type Parameters
- R
Parameters
- Optional member: MemberLambda<T, R>
Returns string
- Defined in src/Patterns/EventStore/EventStore.ts:115

`Private` getStateAtPath

getStateAtPath(path): any
Parameters
- path: string
Returns any
- Defined in src/Patterns/EventStore/EventStore.ts:130

`Private` getTargetObservers

getTargetObservers(path): string[]
Parameters
- path: string
Returns string[]
- Defined in src/Patterns/EventStore/EventStore.ts:170

`Private` parentOf

parentOf(parentPath, childPath): boolean
Parameters
- parentPath: string
- childPath: string
Returns boolean
- Defined in src/Patterns/EventStore/EventStore.ts:186

`Private` publishToDependentObservers

publishToDependentObservers(path): void
Parameters
- path: string
Returns void
- Defined in src/Patterns/EventStore/EventStore.ts:159

`Private` updateState

updateState<V>(member, previousState, value, updateLedger?): void
Type Parameters
- V
Parameters
- member: string | MemberLambda<T, V>
- previousState: any
- value: T | V
- updateLedger: boolean = true
Returns void
- Defined in src/Patterns/EventStore/EventStore.ts:134

Generated using TypeDoc