Skip to main content

@jewel998/state-machine - v0.0.5 / HistoryManager

Class: HistoryManager<TState, TEvent, TContext>

Type parameters​

NameType
TStateextends StateIdentifier
TEventextends EventIdentifier
TContextextends ContextConstraint

Table of contents​

Constructors​

Methods​

Constructors​

constructor​

• new HistoryManager<TState, TEvent, TContext>(maxHistorySize?): HistoryManager<TState, TEvent, TContext>

Type parameters​

NameType
TStateextends StateIdentifier
TEventextends EventIdentifier
TContextextends ContextConstraint

Parameters​

NameTypeDefault value
maxHistorySizenumber1000

Returns​

HistoryManager<TState, TEvent, TContext>

Defined in​

src/history/HistoryManager.ts:20

Methods​

addEvent​

▸ addEvent(event): void

Parameters​

NameType
eventStateChangeEvent<TState, TEvent, TContext>

Returns​

void

Defined in​

src/history/HistoryManager.ts:24

getHistory​

▸ getHistory(): readonly StateChangeEvent<TState, TEvent, TContext>[]

Returns​

readonly StateChangeEvent<TState, TEvent, TContext>[]

Defined in​

src/history/HistoryManager.ts:33

getRecentHistory​

▸ getRecentHistory(count): readonly StateChangeEvent<TState, TEvent, TContext>[]

Parameters​

NameType
countnumber

Returns​

readonly StateChangeEvent<TState, TEvent, TContext>[]

Defined in​

src/history/HistoryManager.ts:37

clear​

▸ clear(): void

Returns​

void

Defined in​

src/history/HistoryManager.ts:43

getHistorySize​

▸ getHistorySize(): number

Returns​

number

Defined in​

src/history/HistoryManager.ts:47

findEventsByState​

▸ findEventsByState(state): readonly StateChangeEvent<TState, TEvent, TContext>[]

Parameters​

NameType
stateTState

Returns​

readonly StateChangeEvent<TState, TEvent, TContext>[]

Defined in​

src/history/HistoryManager.ts:51

findEventsByEvent​

▸ findEventsByEvent(eventType): readonly StateChangeEvent<TState, TEvent, TContext>[]

Parameters​

NameType
eventTypeTEvent

Returns​

readonly StateChangeEvent<TState, TEvent, TContext>[]

Defined in​

src/history/HistoryManager.ts:59

getLastEvent​

▸ getLastEvent(): undefined | StateChangeEvent<TState, TEvent, TContext>

Returns​

undefined | StateChangeEvent<TState, TEvent, TContext>

Defined in​

src/history/HistoryManager.ts:65