Instance | @steelbreeze/state

Represents an instance of a state machine model at runtime; contains the active state configuration and manages transactions. There can be many seperate state machine instances using a common model.

Hierarchy

Map<Region, State>
- Instance

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Instance(name: string, root: State): Instance

Overrides Map<Region, State>.constructor
- Defined in src/Instance.ts:20
Creates a new state machine instance conforming to a particular state machine model.

Parameters
- name: string
  
  The name of the state machine instance.
- root: State
  
  The root state of the state machine instance.
Returns Instance

Properties

Readonly [Symbol.toStringTag]

[Symbol.toStringTag]: string

Readonly name

name: string

Readonly root

root: State

Readonly size

size: number

Static Readonly [Symbol.species]

[Symbol.species]: MapConstructor

Methods

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<[Region, State]>

Inherited from Map.__@iterator
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
Returns an iterable of entries in the map.

Returns IterableIterator<[Region, State]>

clear

clear(): void

Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:22
Returns void

delete

delete(key: Region): boolean

Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:23
Parameters
- key: Region
Returns boolean

entries

entries(): IterableIterator<[Region, State]>

Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:126
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[Region, State]>

evaluate

evaluate(trigger: any): boolean

- Defined in src/Instance.ts:44
Evaluates a trigger event to see if it causes a state transition.

Parameters
- trigger: any
  
  The trigger event to evaluate.
Returns boolean

Returns true if the trigger event caused a change in the active state configuration or was deferred.

forEach

forEach(callbackfn: (value: State, key: Region, map: Map<Region, State>) => void, thisArg?: any): void

Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24
Parameters
- callbackfn: (value: State, key: Region, map: Map<Region, State>) => void
  - - (value: State, key: Region, map: Map<Region, State>): void
    - Parameters
      - value: State
      - key: Region
      - map: Map<Region, State>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: Region): undefined | State

Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:25
Parameters
- key: Region
Returns undefined | State

has

has(key: Region): boolean

Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:26
Parameters
- key: Region
Returns boolean

keys

keys(): IterableIterator<Region>

Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:131
Returns an iterable of keys in the map

Returns IterableIterator<Region>

set

set(key: Region, value: State): Instance

Inherited from Map.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:27
Parameters
- key: Region
- value: State
Returns Instance

toString

toString(): string

- Defined in src/Instance.ts:144
Returns the name of the state machine instance.

Returns string

Returns the name of the state machine instance.

values

values(): IterableIterator<State>

Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:136
Returns an iterable of values in the map

Returns IterableIterator<State>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

root: State

Returns Instance

Properties

Readonly [Symbol.toStringTag]

Readonly name

Readonly root

Readonly size

Static Readonly [Symbol.species]

Methods

[Symbol.iterator]

Returns IterableIterator<[Region, State]>

clear

Returns void

delete

Parameters

key: Region

Returns boolean

entries

Returns IterableIterator<[Region, State]>

evaluate

Parameters

trigger: any

Returns boolean

forEach

Parameters

callbackfn: (value: State, key: Region, map: Map<Region, State>) => void

Parameters

value: State

key: Region

map: Map<Region, State>

Returns void

Optional thisArg: any

Returns void

get

Parameters

key: Region

Returns undefined | State

has

Parameters

key: Region

Returns boolean

keys

Returns IterableIterator<Region>

set

Parameters

key: Region

value: State

Returns Instance

toString

Returns string

values

Returns IterableIterator<State>