Class StateMachine<Context, Events, States>

Type Parameters

Context = any
Events extends Record<string, any> = Record<string, any>
States extends string = string

Index

Constructors

Accessors

Methods

off on ready send

Constructors

constructor

new StateMachine<
    Context = any,
    Events extends Record<string, any> = Record<string, any>,
    States extends string = string,
>(
    config: MachineConfig<Context, Events, States>,
    options?: MachineOptions,
): StateMachine<Context, Events, States>
Type Parameters
- Context = any
- Events extends Record<string, any> = Record<string, any>
- States extends string = string
Parameters
- config: MachineConfig<Context, Events, States>
- Optionaloptions: MachineOptions
Returns StateMachine<Context, Events, States>
- Defined in packages/state-machine/src/machine.ts:38

Accessors

context

get context(): Context
Returns Context
- Defined in packages/state-machine/src/machine.ts:82

state

get state(): States
Returns States
- Defined in packages/state-machine/src/machine.ts:76

Methods

off

off(event: string | RegExp, listener?: (payload: any) => void): void
Remove a listener for a state or pattern.
Parameters
- event: string | RegExp
- Optionallistener: (payload: any) => void
Returns void
- Defined in packages/state-machine/src/machine.ts:184

on

on(
    event: string | RegExp,
    listener: (payload: any) => void,
    options?: ListenerOptions,
): Cleanup
Listen for state transitions.
Parameters
- event: string | RegExp
- listener: (payload: any) => void
- Optionaloptions: ListenerOptions
Returns Cleanup
Example
```
machine.on('error', ({ context, from, event }) => { ... })
    machine.on('*', (payload) => { ... })
    machine.on('$rejected', ({ state, event, reason }) => { ... })
    machine.on(/error|failed/, (payload) => { ... })
```
- Defined in packages/state-machine/src/machine.ts:171

ready

ready(): Promise<void>
Returns a promise that resolves when the machine is hydrated from persistence. If no persistence is configured, resolves immediately.

Returns Promise<void>
- Defined in packages/state-machine/src/machine.ts:194

send

send<E extends string | number | symbol>(
    ...args: Events[E] extends void
        ? [event: E]
        : [event: E, data: Events[E]],
): void
Attempt a state transition by sending an event.
Type Parameters
- E extends string | number | symbol
Parameters
- ...args: Events[E] extends void ? [event: E] : [event: E, data: Events[E]]
Returns void
Example
```
machine.send('FETCH')
    machine.send('ADD_ITEM', { id: '1', name: 'Widget' })
```
- Defined in packages/state-machine/src/machine.ts:95