Interface IEventStore<T>

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

interface IEventStore<T> {
    GetLedger(): Transaction<T>[];
    GetState(): T;
    GetState<V>(member): V;
    ObservableAt(): Observable<T>;
    ObservableAt<V>(member): Observable<V>;
    Redo(): Result<undefined | T>;
    SetState<T>(state): Result<T>;
    SetState<V>(member, state): Result<V>;
    Undo(): Result<undefined | T>;
}

Type Parameters

T extends object

Implemented by

EventStore

Index

Methods

GetLedger GetState ObservableAt Redo SetState Undo

Methods

GetLedger

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

Returns Transaction<T>[]
- Defined in src/Patterns/EventStore/IEventStore.ts:54

GetState

GetState(): T
Returns a copy of the current state

Returns T
- Defined in src/Patterns/EventStore/IEventStore.ts:15
GetState<V>(member): V
Returns a portion of the state based on the given path
Type Parameters
- V
Parameters
- member: string | MemberLambda<T, V>
Returns V
- Defined in src/Patterns/EventStore/IEventStore.ts:21

ObservableAt

ObservableAt(): Observable<T>
Returns an observable which can be subscribed to in order to act on ANY state changes within the store

Returns Observable<T>
- Defined in src/Patterns/EventStore/IEventStore.ts:41
ObservableAt<V>(member): Observable<V>
Returns an observable which can be subscribed to in order to act on state changes
Type Parameters
- V
Parameters
- member: string | MemberLambda<T, V>
Returns Observable<V>
- Defined in src/Patterns/EventStore/IEventStore.ts:48

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>
- Defined in src/Patterns/EventStore/IEventStore.ts:67

SetState

SetState<T>(state): Result<T>
Update the current state of the entire store
Type Parameters
- T
Parameters
- state: T
  state to set at a root level
Returns Result<T>
- Defined in src/Patterns/EventStore/IEventStore.ts:27
SetState<V>(member, state): Result<V>
Sets the state at a given path, returning a result indicating success and a copy of the state set
Type Parameters
- V
Parameters
- member: string | MemberLambda<T, V>
- state: V
  state to set
Returns Result<V>
- Defined in src/Patterns/EventStore/IEventStore.ts:35

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>
- Defined in src/Patterns/EventStore/IEventStore.ts:60

Interface IEventStore<T>

Type Parameters

T extends object

Implemented by

Index

Methods

Methods

GetLedger

Returns Transaction<T>[]

GetState

Returns T

Type Parameters

V

Parameters

member: string | MemberLambda<T, V>

Returns V

ObservableAt

Returns Observable<T>

Type Parameters

V

Parameters

member: string | MemberLambda<T, V>

Returns Observable<V>

Redo

Returns Result<undefined | T>

SetState

Type Parameters

T

Parameters

state: T

Returns Result<T>

Type Parameters

V

Parameters

member: string | MemberLambda<T, V>

state: V

Returns Result<V>

Undo

Returns Result<undefined | T>

Settings

Member Visibility

Theme

On This Page