ReactAutomaton | Automatons

This class is used to extend Automaton functionality so it can be used with React components.

ReactAutomaton always passes the host component instance to it's transition functions as the first argument.

Hierarchy

Automaton
- ReactAutomaton

Index

Constructors

constructor

Properties

Accessors

state

Methods

Constructors

constructor

new ReactAutomaton(component: IAutomatonComponent): ReactAutomaton

Overrides Automaton.constructor
- Defined in classes/ReactBinding.ts:84
Parameters
- component: IAutomatonComponent
Returns ReactAutomaton

Properties

Private component

component: IAutomatonComponent

Private handlers

handlers: IReactEventHandlers

mapToState

mapToState: string

Accessors

state

state:

Current state of the Automaton.

Methods

Protected doTransition

doTransition(implementation: TransitionFunction, ...args: any[]): void

Overrides Automaton.doTransition
- Defined in classes/ReactBinding.ts:133
Calls transition implementation, passing the host component instance.

Parameters
- implementation: TransitionFunction
- Rest ...args: any[]
Returns void

reset

reset(): void

Inherited from Automaton.reset
- Defined in classes/Automaton.ts:132
Resets Automaton state back to INITIAL.

Returns void

signal

signal(signal: Signal): React.EventHandler<any>

- Defined in classes/ReactBinding.ts:95
This method is used by asSignal to produce signaling event handlers.

Parameters
- signal: Signal
Returns React.EventHandler<any>

transition

transition(signal: Signal, ...args: any[]): void

Overrides Automaton.transition
- Defined in classes/ReactBinding.ts:113
Performs a transition and calls setState if mapToState is enabled.

Parameters
- signal: Signal
- Rest ...args: any[]
Returns void

Generated using TypeDoc