Skip to content

Latest commit

 

History

History
304 lines (184 loc) · 5.97 KB

README.md

File metadata and controls

304 lines (184 loc) · 5.97 KB

@corey.burrows/statechart

@corey.burrows/statechart

Table of contents

Classes

Interfaces

Type aliases

Type aliases

Action

Ƭ Action<E>: ActionObj<E> | ActionFn<E>

Type parameters

Name
E

Defined in

types.ts:17


ActionFn

Ƭ ActionFn<E>: (send: SendFn<E>) => void

Type parameters

Name
E

Type declaration

▸ (send): void

Parameters
Name Type
send SendFn<E>
Returns

void

Defined in

types.ts:15


ConditionFn

Ƭ ConditionFn<C, E>: (ctx: C, evt: InternalEvent | E) => string | undefined

Type parameters

Name Type
C C
E extends Event

Type declaration

▸ (ctx, evt): string | undefined

Parameters
Name Type
ctx C
evt InternalEvent | E
Returns

string | undefined

Defined in

types.ts:59


EnterHandler

Ƭ EnterHandler<C, E>: (ctx: C, evt: InternalEvent | E) => EnterHandlerResult<C, E> | void

Type parameters

Name Type
C C
E extends Event

Type declaration

▸ (ctx, evt): EnterHandlerResult<C, E> | void

Parameters
Name Type
ctx C
evt InternalEvent | E
Returns

EnterHandlerResult<C, E> | void

Defined in

types.ts:42


EventHandler

Ƭ EventHandler<C, E, T>: (ctx: C, evt: Extract<E, { type: T }>) => EventHandlerResult<C, E> | void

Type parameters

Name Type
C C
E extends Event
T extends E["type"] | InternalEvent["type"]

Type declaration

▸ (ctx, evt): EventHandlerResult<C, E> | void

Parameters
Name Type
ctx C
evt Extract<E, { type: T }>
Returns

EventHandlerResult<C, E> | void

Defined in

types.ts:53


EventHandlerResult

Ƭ EventHandlerResult<C, E>: Object

Type parameters

Name Type
C C
E extends Event

Type declaration

Name Type
actions? Action<E>[]
context? C
goto? string | string[]

Defined in

types.ts:47


ExitHandler

Ƭ ExitHandler<C, E>: (ctx: C, evt: InternalEvent | E) => ExitHandlerResult<C, E> | void

Type parameters

Name Type
C C
E extends Event

Type declaration

▸ (ctx, evt): ExitHandlerResult<C, E> | void

Parameters
Name Type
ctx C
evt InternalEvent | E
Returns

ExitHandlerResult<C, E> | void

Defined in

types.ts:31


InternalEvent

Ƭ InternalEvent: { type: "__start__" } | { type: "__stop__" }

Defined in

types.ts:7


NodeBody

Ƭ NodeBody<C, E>: (n: Node<C, E>) => void

Type parameters

Name Type
C C
E extends Event

Type declaration

▸ (n): void

Parameters
Name Type
n Node<C, E>
Returns

void

Defined in

types.ts:24


SendFn

Ƭ SendFn<E>: (event: E) => void

Type parameters

Name
E

Type declaration

▸ (event): void

Parameters
Name Type
event E
Returns

void

Defined in

types.ts:9