<internal> | JSSM, a JavaScript state machine

Index

Classes

circular_buffer

Interfaces

Type Aliases

AfterHook

AfterHook<mDT>: { from: string; handler: HookHandler<mDT>; kind: "after" }

Type Parameters

Type declaration

from: string
handler: HookHandler<mDT>
kind: "after"

AnyActionHook

AnyActionHook<mDT>: { handler: HookHandler<mDT>; kind: "any action" }

Type Parameters

Type declaration

handler: HookHandler<mDT>
kind: "any action"

AnyTransitionHook

AnyTransitionHook<mDT>: { handler: HookHandler<mDT>; kind: "any transition" }

Type Parameters

Type declaration

handler: HookHandler<mDT>
kind: "any transition"

BasicHookDescription

BasicHookDescription<mDT>: { from: string; handler: HookHandler<mDT>; kind: "hook"; to: string }

Type Parameters

Type declaration

from: string
handler: HookHandler<mDT>
kind: "hook"
to: string

EntryHook

EntryHook<mDT>: { handler: HookHandler<mDT>; kind: "entry"; to: string }

Type Parameters

Type declaration

handler: HookHandler<mDT>
kind: "entry"
to: string

EverythingHook

EverythingHook<mDT>: { handler: EverythingHookHandler<mDT>; kind: "everything" }

Type Parameters

Type declaration

handler: EverythingHookHandler<mDT>
kind: "everything"

ExitHook

ExitHook<mDT>: { from: string; handler: HookHandler<mDT>; kind: "exit" }

Type Parameters

Type declaration

from: string
handler: HookHandler<mDT>
kind: "exit"

ForcedTransitionHook

ForcedTransitionHook<mDT>: { handler: HookHandler<mDT>; kind: "forced transition" }

Type Parameters

Type declaration

handler: HookHandler<mDT>
kind: "forced transition"

GlobalActionHook

GlobalActionHook<mDT>: { action: string; handler: HookHandler<mDT>; kind: "global action" }

Type Parameters

Type declaration

action: string
handler: HookHandler<mDT>
kind: "global action"

HookDescriptionWithAction

HookDescriptionWithAction<mDT>: { action: string; from: string; handler: HookHandler<mDT>; kind: "named"; to: string }

Type Parameters

Type declaration

action: string
from: string
handler: HookHandler<mDT>
kind: "named"
to: string

JssmCorner

JssmCorner: "regular" | "rounded" | "lined"

JssmFailure

JssmFailure: { error: any; success: false }

Composite type indicating an error, and the reason for it, as part of a result.

Type declaration

error: any
success: false

JssmIncomplete

JssmIncomplete: { success: "incomplete" }

Composite type indicating that a result isn't finished yet.

Type declaration

success: "incomplete"

JssmLineStyle

JssmLineStyle: "solid" | "dashed" | "dotted"

JssmStatePermitter

JssmStatePermitter<DataType>: ((OldState: StateType, NewState: StateType, OldData: DataType, NewData: DataType) => boolean)

Type Parameters

DataType

Type declaration

- (OldState: StateType, NewState: StateType, OldData: DataType, NewData: DataType): boolean
- Parameters
  - OldState: StateType
  - NewState: StateType
  - OldData: DataType
  - NewData: DataType
  Returns boolean

JssmStatePermitterMaybeArray

JssmStatePermitterMaybeArray<DataType>: JssmStatePermitter<DataType> | JssmStatePermitter<DataType>[]

Type Parameters

DataType

JssmStateStyleBackgroundColor

JssmStateStyleBackgroundColor: { key: "background-color"; value: JssmColor }

Type declaration

key: "background-color"
value: JssmColor

JssmStateStyleBorderColor

JssmStateStyleBorderColor: { key: "border-color"; value: JssmColor }

Type declaration

key: "border-color"
value: JssmColor

JssmStateStyleColor

JssmStateStyleColor: { key: "color"; value: JssmColor }

Type declaration

key: "color"
value: JssmColor

JssmStateStyleCorners

JssmStateStyleCorners: { key: "corners"; value: JssmCorner }

Type declaration

key: "corners"
value: JssmCorner

JssmStateStyleImage

JssmStateStyleImage: { key: "image"; value: string }

Type declaration

key: "image"
value: string

JssmStateStyleLineStyle

JssmStateStyleLineStyle: { key: "line-style"; value: JssmLineStyle }

Type declaration

key: "line-style"
value: JssmLineStyle

JssmStateStyleShape

JssmStateStyleShape: { key: "shape"; value: JssmShape }

Type declaration

key: "shape"
value: JssmShape

JssmStateStyleStateLabel

JssmStateStyleStateLabel: { key: "state-label"; value: string }

Type declaration

key: "state-label"
value: string

JssmStateStyleTextColor

JssmStateStyleTextColor: { key: "text-color"; value: JssmColor }

Type declaration

key: "text-color"
value: JssmColor

JssmStateStyleUrl

JssmStateStyleUrl: { key: "url"; value: string }

Type declaration

key: "url"
value: string

JssmSuccess

JssmSuccess: { success: true }

Composite type indicating success as part of a result.

Type declaration

success: true

JssmTransitionCycle

JssmTransitionCycle: { key: "cycle"; value: StateType }

Internal marker used by the compiler to indicate a cycle declaration in the parse stream, rather than a literal state name. See JssmTransitionRule.

Type declaration

key: "cycle"
value: StateType

JssmTransitionPermitter

JssmTransitionPermitter<DataType>: ((OldState: StateType, NewState: StateType, OldData: DataType, NewData: DataType) => boolean)

Type Parameters

DataType

Type declaration

- (OldState: StateType, NewState: StateType, OldData: DataType, NewData: DataType): boolean
- Parameters
  - OldState: StateType
  - NewState: StateType
  - OldData: DataType
  - NewData: DataType
  Returns boolean

JssmTransitionPermitterMaybeArray

JssmTransitionPermitterMaybeArray<DataType>: JssmTransitionPermitter<DataType> | JssmTransitionPermitter<DataType>[]

Type Parameters

DataType

MainTransitionHook

MainTransitionHook<mDT>: { handler: HookHandler<mDT>; kind: "main transition" }

Type Parameters

Type declaration

handler: HookHandler<mDT>
kind: "main transition"

PostAnyActionHook

PostAnyActionHook<mDT>: { handler: PostHookHandler<mDT>; kind: "post any action" }

Type Parameters

Type declaration

handler: PostHookHandler<mDT>
kind: "post any action"

PostAnyTransitionHook

PostAnyTransitionHook<mDT>: { handler: PostHookHandler<mDT>; kind: "post any transition" }

Type Parameters

Type declaration

handler: PostHookHandler<mDT>
kind: "post any transition"

PostBasicHookDescription

PostBasicHookDescription<mDT>: { from: string; handler: PostHookHandler<mDT>; kind: "post hook"; to: string }

Type Parameters

Type declaration

from: string
handler: PostHookHandler<mDT>
kind: "post hook"
to: string

PostEntryHook

PostEntryHook<mDT>: { handler: PostHookHandler<mDT>; kind: "post entry"; to: string }

Type Parameters

Type declaration

handler: PostHookHandler<mDT>
kind: "post entry"
to: string

PostEverythingHook

PostEverythingHook<mDT>: { handler: PostEverythingHookHandler<mDT>; kind: "post everything" }

Type Parameters

Type declaration

handler: PostEverythingHookHandler<mDT>
kind: "post everything"

PostExitHook

PostExitHook<mDT>: { from: string; handler: PostHookHandler<mDT>; kind: "post exit" }

Type Parameters

Type declaration

from: string
handler: PostHookHandler<mDT>
kind: "post exit"

PostForcedTransitionHook

PostForcedTransitionHook<mDT>: { handler: PostHookHandler<mDT>; kind: "post forced transition" }

Type Parameters

Type declaration

handler: PostHookHandler<mDT>
kind: "post forced transition"

PostGlobalActionHook

PostGlobalActionHook<mDT>: { action: string; handler: PostHookHandler<mDT>; kind: "post global action" }

Type Parameters

Type declaration

action: string
handler: PostHookHandler<mDT>
kind: "post global action"

PostHookDescriptionWithAction

PostHookDescriptionWithAction<mDT>: { action: string; from: string; handler: PostHookHandler<mDT>; kind: "post named"; to: string }

Type Parameters

Type declaration

action: string
from: string
handler: PostHookHandler<mDT>
kind: "post named"
to: string

PostHookHandler

PostHookHandler<mDT>: ((hook_context: HookContext<mDT>) => void)

Type Parameters

Type declaration

- (hook_context: HookContext<mDT>): void
- Signature of a post-transition hook handler. Invoked after a successful transition has been committed; the return value is ignored (the transition cannot be undone).
  
  Parameters
  - hook_context: HookContext<mDT>
  Returns void

PostMainTransitionHook

PostMainTransitionHook<mDT>: { handler: PostHookHandler<mDT>; kind: "post main transition" }

Type Parameters

Type declaration

handler: PostHookHandler<mDT>
kind: "post main transition"

PostStandardTransitionHook

PostStandardTransitionHook<mDT>: { handler: PostHookHandler<mDT>; kind: "post standard transition" }

Type Parameters

Type declaration

handler: PostHookHandler<mDT>
kind: "post standard transition"

PreEverythingHook

PreEverythingHook<mDT>: { handler: EverythingHookHandler<mDT>; kind: "pre everything" }

Type Parameters

Type declaration

handler: EverythingHookHandler<mDT>
kind: "pre everything"

PrePostEverythingHook

PrePostEverythingHook<mDT>: { handler: PostEverythingHookHandler<mDT>; kind: "pre post everything" }

Type Parameters

Type declaration

handler: PostEverythingHookHandler<mDT>
kind: "pre post everything"

Record

Record<K, T>: { [ P in K]: T }

Construct a type with a set of properties K of type T

Type Parameters

K extends keyof any
T

StandardTransitionHook

StandardTransitionHook<mDT>: { handler: HookHandler<mDT>; kind: "standard transition" }

Type Parameters

Type declaration

handler: HookHandler<mDT>
kind: "standard transition"

StateType

StateType: string

TraversalFunctor

TraversalFunctor<T>: ((_element: T, _index?: number, _array?: T[]) => unknown)

Type Parameters

Type declaration

- (_element: T, _index?: number, _array?: T[]): unknown
- Parameters
  - _element: T
  - Optional _index: number
  - Optional _array: T[]
  Returns unknown