Class StateHub<T>

Type Parameters

T extends Record<string, StateMachine<any, any, any>>

Index

Constructors

Methods

Constructors

constructor

new StateHub<T extends Record<string, StateMachine<any, any, any>>>(
machines: T,
): StateHub<T>
Type Parameters
- T extends Record<string, StateMachine<any, any, any>>
Parameters
- machines: T
Returns StateHub<T>
- Defined in packages/state-machine/src/hub.ts:13

Methods

connect

connect(config: ConnectConfig<T>): Cleanup
Wire machines together declaratively. When the source machine enters the specified state, sends an event to the target machine.

Returns a cleanup function to tear down the connection.
Parameters
- config: ConnectConfig<T>
Returns Cleanup
Example
```
hub.connect({
        from: 'auth',
        enters: 'loggedOut',
        to: 'checkout',
        send: 'RESET',
    })
```
- Defined in packages/state-machine/src/hub.ts:46

get

get<K extends string | number | symbol>(key: K): T[K]
Returns a machine by key, fully typed.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns T[K]
Example
```
const auth = hub.get('auth')
    auth.send('LOGIN', { user: 'admin' })
```
- Defined in packages/state-machine/src/hub.ts:26