TraversalConfig <TSnapshot, TEvent>

Hierarchy

• SerializationConfig<TSnapshot, TEvent>
  • TraversalConfig

Index

Properties

• events
• filter
• fromState
• serializeEvent
• serializeState
• stopCondition
• toState
• traversalLimit

Properties

events

events: readonly TEvent[] | (state: TSnapshot) => readonly TEvent[]

filter

filter: (state: TSnapshot, event: TEvent) => boolean

Type declaration

• • (state: TSnapshot, event: TEvent): boolean

  • Determines whether to traverse a transition from state on event when building the adjacency map.

    ---

    Parameters

    • state: TSnapshot

    • event: TEvent

    Returns boolean

fromState

fromState: undefined | TSnapshot

serializeEvent

serializeEvent: (event: TEvent) => string

Inherited from SerializationConfig.serializeEvent

Type declaration

• • (event: TEvent): string

  • Parameters

    • event: TEvent

    Returns string

serializeState

serializeState: (state: TSnapshot, event: undefined | TEvent, prevState?: TSnapshot) => string

Inherited from SerializationConfig.serializeState

Type declaration

• • (state: TSnapshot, event: undefined | TEvent, prevState?: TSnapshot): string

  • Parameters

    • state: TSnapshot

    • event: undefined | TEvent

    • optionalprevState: TSnapshot

    Returns string

stopCondition

stopCondition: undefined | (state: TSnapshot) => boolean

When true, traversal of the adjacency map will stop for that current state.

toState

toState: undefined | (state: TSnapshot) => boolean

traversalLimit

traversalLimit: number = `Infinity`

The maximum number of traversals to perform when calculating the state transition adjacency map.