StateMachineConfig

The config object used to instantiate a new FSM instance.

Signature

interface StateMachineConfig<T extends string, Data = undefined> {    readonly transitions: Transitions<T>;    onTransitionStart?: OnTransitionStartFn<T, Data>;    onTransitionEnd?: OnTransitionEndFn<T, Data>;    onError?: OnTransitionErrorFn<T>;}

transitions

propertyTransitions<T>

Defines the available states of the state machine as well as the permitted transitions from one state to another.

onTransitionStart

propertyOnTransitionStartFn<T, Data>

Called before a transition takes place. If the function resolves to false or a string, then the transition will be cancelled. In the case of a string, the string (error message) will be forwarded to the onError handler.

If this function returns a value resolving to true or void (no return value), then the transition will be permitted.

onTransitionEnd

propertyOnTransitionEndFn<T, Data>

Called after a transition has taken place.

onError

propertyOnTransitionErrorFn<T>

Called when a transition is prevented and the onTransitionStart handler has returned an error message.

@vendure/core Source

If this function returns a value resolving to true or void (no return value), then the transition will be permitted.

Signature

type OnTransitionStartFn<T extends string, Data> = (    fromState: T,    toState: T,    data: Data,) => boolean | string | void | Promise<boolean | string | void> | Observable<boolean | string | void>

@vendure/core Source

Called when a transition is prevented and the onTransitionStart handler has returned an error message.

Signature

type OnTransitionErrorFn<T extends string> = (    fromState: T,    toState: T,    message?: string,) => void | Promise<void> | Observable<void>

@vendure/core Source

Called after a transition has taken place.

Signature

type OnTransitionEndFn<T extends string, Data> = (    fromState: T,    toState: T,    data: Data,) => void | Promise<void> | Observable<void>