Generated using TypeDoc
Optional override for formatting stack traces
Return the direction of an arrow - right, left, or both.
import { arrow_direction } from 'jssm';
arrow_direction('->'); // 'right'
arrow_direction('<~=>'); // 'both'
The arrow to be evaluated
- Return the direction of an arrow - right, left, or both.
import { arrow_left_kind } from 'jssm';
arrow_left_kind('<-'); // 'legal'
arrow_left_kind('<='); // 'main'
arrow_left_kind('<~'); // 'forced'
arrow_left_kind('<->'); // 'legal'
arrow_left_kind('->'); // 'none'
The arrow to be evaluated
- Return the direction of an arrow - right, left, or both.
import { arrow_left_kind } from 'jssm';
arrow_left_kind('->'); // 'legal'
arrow_left_kind('=>'); // 'main'
arrow_left_kind('~>'); // 'forced'
arrow_left_kind('<->'); // 'legal'
arrow_left_kind('<-'); // 'none'
The arrow to be evaluated
-Compile a machine's JSON intermediate representation to a config object. If you're using this (probably don't,) you're probably also using parse to get the IR, and the object constructor @@ -43,7 +43,7 @@
The type of the machine data member; usually omitted
The parse tree to be boiled down into a machine config
-Create a state machine from an implementation string. This is one of the two main paths for working with JSSM, alongside sm.
Use this method when you want to conveniently pull a state machine from a @@ -57,7 +57,7 @@
The FSL code to evaluate
Extra non-code configuration to pass at creation time
-The FSL code to be evaluated and built into a machine config
-This method wraps the parser call that comes from the peg grammar, parse. Generally neither this nor that should be used directly unless you mean to develop plugins or extensions for the machine.
@@ -96,7 +96,7 @@The FSL code to be evaluated
Things to control about the instance
-Create a state machine from a template string. This is one of the two main paths for working with JSSM, alongside from.
Use this method when you want to work directly and conveniently with a @@ -110,7 +110,7 @@
The assembled code
The mechanic for template argument insertion
-An internal method meant to take a series of declarations and fold them into a single multi-faceted declaration, in the process of building a state. Not generally meant for external use.
diff --git a/docs/docs/modules/jssm_constants.html b/docs/docs/modules/jssm_constants.html index a39ce724..d9bde09a 100644 --- a/docs/docs/modules/jssm_constants.html +++ b/docs/docs/modules/jssm_constants.html @@ -1 +1 @@ -Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
A type teaching Typescript the various supported shapes for nodes, mostly inherited from GraphViz
-Generated using TypeDoc
Generated using TypeDoc
Returns the histograph of an array as a Map. Makes no attempt to cope
with deep equality; will fail for complex contents, as such.
import { histograph } from './jssm';
histograph( [0, 0, 1, 1, 2, 2, 1] ); // Map()
Predicate for validating an array for uniqueness. Not generally meant for external use.
- Lists all repeated items in an array along with their counts. Subject to
matching rules of Map. NaN is manually removed because of conflict rules
around unique. Because these are compared with === and because
@@ -14,23 +14,23 @@
arrays and objects are never considered repeats.
find_repeated<string>([ ]); // []
find_repeated<string>([ "one" ]); // []
find_repeated<string>([ "one", "two" ]); // []
find_repeated<string>([ "one", "one" ]); // [ ["one", 2] ]
find_repeated<string>([ "one", "two", "one" ]); // [ ["one", 2] ]
find_repeated<number>([ 0, NaN, 0, NaN ]); // [ [0, 2] ]
Internal method generating names for edges for the hook lookup map. Not meant for external use.
-Creates a Mulberry32 random generator. Used by the randomness test suite.
Sourced from bryc at StackOverflow: https://stackoverflow.com/a/47593316/763127
Internal method generating names for edges for the hook lookup map. Not meant for external use.
-Internal method generating names for actions for the hook lookup map. Not meant for external use.
- Returns, for a non-negative integer argument n, the series [0 .. n].
import { seq } from './jssm';
seq(5); // [0, 1, 2, 3, 4]
seq(0); // []
Reduces an array to its unique contents. Compares with === and makes no
effort to deep-compare contents; two matching arrays or objects contained
will be treated as distinct, according to javascript rules. This also means
diff --git a/docs/docs/modules/version.html b/docs/docs/modules/version.html
index 50752579..6e7515e5 100644
--- a/docs/docs/modules/version.html
+++ b/docs/docs/modules/version.html
@@ -1 +1 @@
-
Generated using TypeDoc
Generated using TypeDoc
All notable changes to this project will be documented in this file.
-1038 merges; 148 releases
+1018 merges; 152 releases
Published tags:
-5.80.1, 5.80.0, 5.79.18, 5.79.17, 5.79.16, 5.79.15, 5.79.11, 5.79.10, 5.79.9, 5.79.8, 5.79.6, 5.79.4, 5.79.3, 5.79.2, 5.79.1, 5.79.0, 5.78.0, 5.77.1, 5.77.0, 5.76.2, 5.76.0, 5.75.1, 5.75.0, 5.74.0, 5.73.1, 5.73.0, 5.72.5, 5.72.4, 5.72.3, 5.72.2, 5.72.1, 5.72.0, 5.71.1, 5.71.0, 5.70.36, 5.70.35, 5.70.34, 5.70.33, 5.70.32, 5.70.31, 5.70.30, 5.70.29, 5.70.28, 5.70.27, 5.70.26, 5.70.25, 5.70.24, 5.70.23, 5.70.22, 5.70.21, 5.70.20, 5.70.19, 5.70.18, 5.70.16, 5.70.15, 5.70.14, 5.70.13, 5.70.12, 5.70.11, 5.70.10, 5.70.9, 5.70.8, 5.70.7, 5.70.6, 5.70.5, 5.70.4, 5.70.3, 5.70.2, 5.70.1, 5.70.0, 5.69.4, 5.69.3, 5.69.2, 5.69.0, 5.68.0, 5.67.2, 5.67.0, 5.66.0, 5.65.14, 5.65.12, 5.65.11, 5.65.10, 5.65.9, 5.65.8, 5.65.7, 5.65.5, 5.65.4, 5.65.3, 5.65.2, 5.65.1, 5.65.0, 5.64.2, 5.64.1, 5.64.0, 5.63.0, 5.62.0, 5.61.4, 5.61.3, 5.61.2, 5.61.1, 5.60.4, 5.60.3, 5.60.0, 5.59.1, 5.59.0, 5.58.1, 5.58.0, 5.57.1, 5.57.0, 5.56.2, 5.56.1, 5.55.0, 5.54.0, 5.53.0, 5.52.0, 5.51.0, 5.50.0, 5.49.0, 5.48.0, 5.47.0, 5.46.0, 5.45.2, 5.45.0, 5.44.0, 5.43.2, v5.42.0, 5.42.0, v5.41.15, 5.41.15, v5.41.14, 5.41.14, v5.41.12, 5.41.12, v5.41.10, 5.41.10, v5.41.9, 5.41.9, v5.41.8, 5.41.8, v5.41.7, v5.41.2, v5.41.1, v5.32.14, 5.14.0, 5.12.0, 5.11.12, 5.11.1, 5.11.0
+5.82.1, 5.82.0, 5.81.2, 5.81.0, 5.80.1, 5.80.0, 5.79.18, 5.79.17, 5.79.16, 5.79.15, 5.79.11, 5.79.10, 5.79.9, 5.79.8, 5.79.6, 5.79.4, 5.79.3, 5.79.2, 5.79.1, 5.79.0, 5.78.0, 5.77.1, 5.77.0, 5.76.2, 5.76.0, 5.75.1, 5.75.0, 5.74.0, 5.73.1, 5.73.0, 5.72.5, 5.72.4, 5.72.3, 5.72.2, 5.72.1, 5.72.0, 5.71.1, 5.71.0, 5.70.36, 5.70.35, 5.70.34, 5.70.33, 5.70.32, 5.70.31, 5.70.30, 5.70.29, 5.70.28, 5.70.27, 5.70.26, 5.70.25, 5.70.24, 5.70.23, 5.70.22, 5.70.21, 5.70.20, 5.70.19, 5.70.18, 5.70.16, 5.70.15, 5.70.14, 5.70.13, 5.70.12, 5.70.11, 5.70.10, 5.70.9, 5.70.8, 5.70.7, 5.70.6, 5.70.5, 5.70.4, 5.70.3, 5.70.2, 5.70.1, 5.70.0, 5.69.4, 5.69.3, 5.69.2, 5.69.0, 5.68.0, 5.67.2, 5.67.0, 5.66.0, 5.65.14, 5.65.12, 5.65.11, 5.65.10, 5.65.9, 5.65.8, 5.65.7, 5.65.5, 5.65.4, 5.65.3, 5.65.2, 5.65.1, 5.65.0, 5.64.2, 5.64.1, 5.64.0, 5.63.0, 5.62.0, 5.61.4, 5.61.3, 5.61.2, 5.61.1, 5.60.4, 5.60.3, 5.60.0, 5.59.1, 5.59.0, 5.58.1, 5.58.0, 5.57.1, 5.57.0, 5.56.2, 5.56.1, 5.55.0, 5.54.0, 5.53.0, 5.52.0, 5.51.0, 5.50.0, 5.49.0, 5.48.0, 5.47.0, 5.46.0, 5.45.2, 5.45.0, 5.44.0, 5.43.2, v5.42.0, 5.42.0, v5.41.15, 5.41.15, v5.41.14, 5.41.14, v5.41.12, 5.41.12, v5.41.10, 5.41.10, v5.41.9, 5.41.9, v5.41.8, 5.41.8, v5.41.7, v5.41.2, v5.41.1, v5.32.14, 5.14.0, 5.12.0, 5.11.12, 5.11.1, 5.11.0
++
+ + + + +
Commit 27480ec9b23dc281db0212e68f53aabcdc8b946f
+Author: John Haugeland <stonecypher@gmail.com>
Merges [5278df4, 03e1ad3]
++
+ + +
Commit 03e1ad3acf5074dd570eb9a2e2001abab10fb923
+Author: John Haugeland <stonecypher@gmail.com>
+
+ + + + +
Commit 5278df4d94a347b37da6cdca2a64a6ca85665b42
+Author: John Haugeland <stonecypher@gmail.com>
Merges [72d6ef7, 88d7309]
+
@@ -54,9 +95,11 @@
+ - -
Commit 72d6ef77839234d9763ba3c5e667f0eb5ef43951
Author: John Haugeland <stonecypher@gmail.com>
+ + - -
Commit 5162f2299530514aecba1bf78fbfe77910e3a417
Author: John Haugeland <stonecypher@gmail.com>
- - -
Commit 2fb6d05732af642351819a635e43415afab184ce
-Author: John Haugeland <stonecypher@gmail.com>
-
@@ -415,17 +449,6 @@
- -
Commit 2ad15c12b80887ac1ef61a35fcc0489e842f138f
-Author: John Haugeland <stonecypher@gmail.com>
-
-
- - -
Commit 12f318abf7ae3bea710c10ff4a5b257d482da12f
-Author: John Haugeland <stonecypher@gmail.com>
-
- - -
Commit e2f02c304174ce4e38b3bae43aedf5d0a2c691d3
-Author: John Haugeland <stonecypher@gmail.com>
-
@@ -602,33 +603,6 @@
- - -
Commit 7ff1fcde7a2a0d34beb94a1814f02b93cb30f0de
-Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
-
@@ -743,28 +717,6 @@
- -
Commit 090bc2640fdabe89196ac62aa3b83aa968f5ff8c
-Author: John Haugeland <stonecypher@gmail.com>
.props, fixes StoneCypher/fsl#1019, lots of doc improvements, numeric constants-
- - -
Commit 0f3870d1ca40c7b3fc849f62484afe94629da009
-Author: John Haugeland <stonecypher@gmail.com>
-
-
- - -
Commit 58e88fec3f6412cadfc762f646ed50f6bc10eac6
-Author: John Haugeland <stonecypher@gmail.com>
Merges [1cc0629, 0cc8f7b]
--
- - -
Commit 0cc8f7bad92e4327128237bc9600cedd2e7cbb94
-Author: John Haugeland <stonecypher@gmail.com>
-
@@ -1102,17 +1031,6 @@
- -
Commit 7bf27e64e929c449d613d461fd1de1ceee4e8183
-Author: John Haugeland <stonecypher@gmail.com>
-
-
- - -
Commit 986fd0dd50adcb739f54e4fa3712628c94004505
-Author: John Haugeland <stonecypher@gmail.com>
-
- - -
Commit 0c34b68d5a5d6666895965e5f8b4b9a9dadfe397
-Author: John Haugeland <stonecypher@gmail.com>
-
@@ -2622,17 +2518,6 @@
- - -
Commit 4dbe3833d503a7f5af7563e487ab6f722b01220f
-Author: John Haugeland <stonecypher@gmail.com>
-
@@ -2671,28 +2556,6 @@
- -
Commit 9dbc57da37b83d3fc2a26c7de17aae8fe976a025
-Author: John Haugeland <stonecypher@gmail.com>
-
- - -
Commit 780cc714651030e2a89343620dff20669d317e62
-Author: John Haugeland <stonecypher@gmail.com>
-
-
- -
Commit fbcda324d66dd8b569a4e60b93794af1a3fea8f0
-Author: John Haugeland <stonecypher@gmail.com>
Merges [23c50e2, e993d6b]
--
-
- -
Commit 330a670aaf0b8b793ad5d2c10d3321c9b1dd1b43
-Author: John Haugeland <stonecypher@gmail.com>
-
-
- -
Commit 78a99337c1e690abeac5c9c03c745f50393c43ae
-Author: John Haugeland <stonecypher@gmail.com>
-
-
- -
Commit 92ecbf90777430ab2db1de3d0595c3150368ba6d
-Author: John Haugeland <stonecypher@gmail.com>
Merges [1fa2e0b, 307ecf2]
--
- - -
Commit 307ecf2d66dc79fb6c6576641696a97b917d1b61
-Author: John Haugeland <stonecypher@gmail.com>
-
- - -
Commit 1fa2e0be1bbfdbb4e2627bd4154d9e02da61e377
-Author: John Haugeland <stonecypher@gmail.com>
-
-
- -
Commit 6a6dee46986db783cebbb6d7f7df9be594f61be6
-Author: John Haugeland <stonecypher@gmail.com>
Merges [816a498, e98824f]
--
- - -
Commit e98824f54254cd8b32a755def3a5e0e6d936f842
-Author: John Haugeland <stonecypher@gmail.com>
-
-
- Preparing search index...
- The search index is not available
JSSM, a JavaScript state machine - the FSM for FSLClass Machine<mDT>
Type Parameters
mDT
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Type Parameters
mDT
Parameters
__namedParameters: JssmGenericConfig<mDT>
Returns Machine<mDT>
Properties
_actions
_active_
_any_
_any_
_arrange_
_arrange_
_arrange_
Optional _data
_default_
_dot_
_edge_
_edges
_end_
_end_
_entry_
_exit_
_flow
_forced_
Optional _fsl_
_global_
_graph_
_has_
_has_
_has_
_has_
_has_
_has_
_has_
_has_
_has_
_has_
_has_
_has_
_has_
_has_
_history
_history_
_hooked_
_hooks
_instance_
Optional _machine_
Optional _machine_
Optional _machine_
Optional _machine_
Optional _machine_
Optional _machine_
Optional _machine_
Optional _machine_
_main_
_named_
_named_
_post_
_post_
_post_
_post_
_post_
_post_
_post_
_post_
_post_
_post_
_property_
Optional _raw_
_required_
_reverse_
_reverse_
_standard_
_start_
_start_
_state
_state_
_state_
_state_
_state_
_states
_terminal_
_themes
Accessors
active_
Get the style for the active state. Does not include composition from an applied theme, or things from the underlying base stylesheet; only the modifications applied by this machine.
Returns Partial<JssmStateDeclaration>
end_
Returns Partial<JssmStateDeclaration>
end_
Get the end state style. Does not include composition from an applied theme, or things from the underlying base stylesheet; only the modifications applied by this machine.
@@ -17,7 +17,7 @@ is not a terminal state. -Returns Partial<JssmStateDeclaration>
history
Returns Partial<JssmStateDeclaration>
history
Get a truncated history of the recent states and data of the machine. Turned off by default; configure with
@@ -26,7 +26,7 @@.from('...', {data: 5})by length, or set.history_lengthat runtime.Notice that the machine's current state,
-e, is not in the returned list.Returns [string, mDT][]
history_
Returns [string, mDT][]
history_
Get a truncated history of the recent states and data of the machine, including the current state. Turned off by default; configure with
@@ -38,17 +38,17 @@.from('...', {data: 5})by length, or set.history_lengthat runtime.Notice that the machine's current state,
-e, is in the returned list.Returns [string, mDT][]
history_
Returns [string, mDT][]
history_
Find out how long a history this machine is keeping. Defaults to zero. Settable directly.
Returns number
Returns number
Find out how long a history this machine is keeping. Defaults to zero. Settable directly.
Parameters
to: number
Returns void
hooked_
Parameters
to: number
Returns void
hooked_
Get the hooked state style. Does not include composition from an applied theme, or things from the underlying base stylesheet; only the modifications applied by this machine.
@@ -57,13 +57,13 @@ that would be literally every node. -Returns Partial<JssmStateDeclaration>
standard_
Returns Partial<JssmStateDeclaration>
standard_
Get the standard style for a single state. Does not include composition from an applied theme, or things from the underlying base stylesheet; only the modifications applied by this machine.
Returns Partial<JssmStateDeclaration>
start_
Returns Partial<JssmStateDeclaration>
start_
Get the start state style. Does not include composition from an applied theme, or things from the underlying base stylesheet; only the modifications applied by this machine.
@@ -71,7 +71,7 @@ are the first mentioned state. -Returns Partial<JssmStateDeclaration>
terminal_
Returns Partial<JssmStateDeclaration>
terminal_
Get the terminal state style. Does not include composition from an applied theme, or things from the underlying base stylesheet; only the modifications applied by this machine.
@@ -79,9 +79,9 @@ state without a valid exit transition is terminal. -Returns Partial<JssmStateDeclaration>
themes
Returns ("default" | "modern" | "ocean" | "plain")[]
Parameters
to: "default" | "modern" | "ocean" | "plain" | ("default" | "modern" | "ocean" | "plain")[]
Returns void
Methods
_new_
Returns Partial<JssmStateDeclaration>
themes
Returns ("default" | "modern" | "ocean" | "plain")[]
Parameters
to: "default" | "modern" | "ocean" | "plain" | ("default" | "modern" | "ocean" | "plain")[]
Returns void
Methods
_new_
Internal method for fabricating states. Not meant for external use.
-Parameters
state_config: JssmGenericState
Returns string
action
Parameters
state_config: JssmGenericState
Returns string
action
Instruct the machine to complete an action. Synonym for do.
The action to engage
Optional newData: mDT
The data change to insert during the action
-Returns boolean
actions
Returns boolean
actions
List all actions available from this state. Please note that the order of the actions is not guaranteed.
Parameters
whichState: string = ...
The state whose actions to have listed
-Returns string[]
all_
Returns ("default" | "modern" | "ocean" | "plain")[]
current_
Parameters
action: string
Returns JssmTransition<mDT>
current_
Parameters
action: string
Returns number
data
Returns string[]
all_
Returns ("default" | "modern" | "ocean" | "plain")[]
current_
Parameters
action: string
Returns JssmTransition<mDT>
current_
Parameters
action: string
Returns number
data
Get the current data of a machine.
Returns mDT
do
Returns mDT
do
Instruct the machine to complete an action. Synonym for action.
The action to engage
Optional newData: mDT
The data change to insert during the action
-Returns boolean
dot_
Returns string
edges_
Parameters
from: string
to: string
Returns JssmTransition<mDT>[]
flow
Returns "up" | "right" | "down" | "left"
force_
Returns boolean
dot_
Returns string
edges_
Parameters
from: string
to: string
Returns JssmTransition<mDT>[]
flow
Returns "up" | "right" | "down" | "left"
force_
Instruct the machine to complete a forced transition (which will reject if called with a normal transition call.)
Optional newData: mDT
The data change to insert during the transition
-Returns boolean
fsl_
Returns string
get_
Parameters
from: string
to: string
Returns number
go
Returns boolean
fsl_
Returns string
get_
Parameters
from: string
to: string
Returns number
go
Instruct the machine to complete a transition. Synonym for transition.
The state to switch to
Optional newData: mDT
The data change to insert during the transition
-Returns boolean
graph_
Returns string
has_
Returns boolean
has_
Returns boolean
graph_
Returns string
has_
Returns boolean
has_
Check whether the machine knows a given state.
Parameters
whichState: string
The state to be checked for extance
-Returns boolean
has_
Returns boolean
has_
Returns boolean
hook
Parameters
from: string
to: string
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
from: string
to: string
action: string
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
to: string
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
from: string
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
action: string
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
instance_
Returns string
is_
Returns boolean
is_
Returns boolean
has_
Returns boolean
has_
Returns boolean
hook
Parameters
from: string
to: string
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
from: string
to: string
action: string
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
to: string
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
from: string
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
action: string
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
hook_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
instance_
Returns string
is_
Returns boolean
is_
Check whether a given state is a valid start state (either because it was explicitly named as such, or because it was the first mentioned state.)
Parameters
whichState: string
The name of the state to check
-Returns boolean
is_
Returns boolean
is_
Check whether the current state is final (either has no exits or is marked
complete.)Returns boolean
is_
Returns boolean
is_
Check whether a given state is a valid start state (either because it was explicitly named as such, or because it was the first mentioned state.)
Parameters
whichState: string
The name of the state to check
-Returns boolean
is_
Returns boolean
is_
Parameters
whichState: string
Returns boolean
known_
Returns boolean
is_
Returns boolean
is_
Parameters
whichState: string
Returns boolean
known_
Check whether a given string is a known property's name.
Parameters
prop_name: string
The relevant property name to look up
-Returns boolean
known_
Returns boolean
known_
List all known property names. If you'd also like values, use props instead. The order of the properties is not defined, and the properties generally will not be sorted.
Returns string[]
label_
Returns string[]
label_
Get the label for a given state, if any; return
undefinedotherwise.Parameters
state: string
Returns string
list_
Returns string[]
list_
Parameters
state: string
Returns string
list_
Returns string[]
list_
Lists all edges of a machine.
Returns JssmTransition<mDT>[]
list_
Returns JssmTransition<mDT>[]
list_
List all entrances attached to the current state. Please note that the order of the list is not defined.
Parameters
whichState: string = ...
The state whose entrances to have listed
-Returns string[]
list_
Parameters
whichState: string = ...
Returns string[]
list_
Returns string[]
list_
Parameters
whichState: string = ...
Returns string[]
list_
List all exits attached to the current state. Please note that the order of the list is not defined.
Parameters
whichState: string = ...
The state whose exits to have listed
-Returns string[]
list_
Returns Map<string, number>
list_
Returns string[]
list_
Returns Map<string, number>
list_
List all states that have a specific action attached. Please note that the order of the states is not guaranteed.
Parameters
whichState: string
The action to be checked for associated states
-Returns string[]
list_
Returns string[]
list_
List all transitions attached to the current state, sorted by entrance and exit. The order of each sublist is not defined. A node could appear in both lists.
@@ -199,7 +199,7 @@Parameters
whichState: string = ...
The state whose transitions to have listed
-Returns JssmTransitionList
lookup_
Parameters
from: string
to: string
Returns JssmTransition<mDT>
machine_
Returns string[]
machine_
Returns string
machine_
Returns string[]
machine_
Returns string
machine_
Returns string
machine_
Returns string
machine_
Returns string
machine_
Returns JssmMachineInternalState<mDT>
machine_
Returns string
post_
Parameters
from: string
to: string
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
from: string
to: string
action: string
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
to: string
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
from: string
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
action: string
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
probabilistic_
Parameters
n: number
Returns Map<string, number>
probabilistic_
Returns boolean
probabilistic_
Parameters
n: number
Returns string[]
probable_
Parameters
whichState: string = ...
Returns any[]
probable_
Parameters
whichState: string
Returns JssmTransition<mDT>[]
prop
Returns JssmTransitionList
lookup_
Parameters
from: string
to: string
Returns JssmTransition<mDT>
machine_
Returns string[]
machine_
Returns string
machine_
Returns string[]
machine_
Returns string
machine_
Returns string
machine_
Returns string
machine_
Returns string
machine_
Returns JssmMachineInternalState<mDT>
machine_
Returns string
post_
Parameters
from: string
to: string
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
from: string
to: string
action: string
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
to: string
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
from: string
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
action: string
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
post_
Parameters
handler: HookHandler<mDT>
Returns Machine<mDT>
probabilistic_
Parameters
n: number
Returns Map<string, number>
probabilistic_
Returns boolean
probabilistic_
Parameters
n: number
Returns string[]
probable_
Parameters
whichState: string = ...
Returns any[]
probable_
Parameters
whichState: string
Returns JssmTransition<mDT>[]
prop
Get the current value of a given property name.
The relevant property name to look up
Returns any
The value behind the prop name. Because functional props are evaluated as getters, this can be anything.
-props
props
Get the current value of every prop, as an object. If no current definition exists for a prop - that is, if the prop was defined without a default and the current state also doesn't define the prop - then that prop will be listed in the returned object with a value of
undefined.Returns object
raw_
Returns <internal>.Object[]
serialize
Returns object
raw_
Returns <internal>.Object[]
serialize
Serialize the current machine, including all defining state but not the machine string, to a structure. This means you will need the machine string to recreate (to not waste repeated space;) if you want the machine string embedded, call {@link serialize_with_string} instead.
-Parameters
Optional comment: string
Returns JssmSerialization<mDT>
set_
Parameters
HookDesc: HookDescription<mDT>
Returns void
sm
Parameters
template_strings: TemplateStringsArray
Rest ...remainder: any[]
Returns Machine<mDT>
state
Parameters
Optional comment: string
Returns JssmSerialization<mDT>
set_
Parameters
HookDesc: HookDescription<mDT>
Returns void
sm
Parameters
template_strings: TemplateStringsArray
Rest ...remainder: any[]
Returns Machine<mDT>
state
Get the current state of a machine.
Returns string
state_
Parameters
which: string
Returns JssmStateDeclaration
state_
Returns Map<string, JssmStateDeclaration>
state_
Parameters
whichState: string
Returns JssmGenericState
state_
Parameters
whichState: string
Returns boolean
state_
Returns string
state_
Parameters
which: string
Returns JssmStateDeclaration
state_
Returns Map<string, JssmStateDeclaration>
state_
Parameters
whichState: string
Returns JssmGenericState
state_
Parameters
whichState: string
Returns boolean
state_
Check whether a given state is final (either has no exits or is marked
complete.)Parameters
whichState: string
The name of the state to check for finality
-Returns boolean
state_
Parameters
whichState: string
Returns boolean
states
Returns boolean
state_
Parameters
whichState: string
Returns boolean
states
List all the states known by the machine. Please note that the order of these states is not guaranteed.
Returns string[]
strict_
Returns string[]
strict_
Get the current value of a given property name. If missing on the state and without a global default, throw, unlike prop, which would return
@@ -245,7 +245,7 @@undefinedinstead.The relevant property name to look up
Returns any
The value behind the prop name. Because functional props are evaluated as getters, this can be anything.
-style_
style_
Gets the composite style for a specific node by individually imposing the style layers on a given object, after determining which layers are appropriate.
@@ -256,7 +256,7 @@ terminal styles; then the start styles; then the end styles; finally, the active styles. Remember, last wins.The base state style must exist. All other styles are optional.
-Parameters
state: string
Returns Partial<JssmStateDeclaration>
transition
Parameters
state: string
Returns Partial<JssmStateDeclaration>
transition
Instruct the machine to complete a transition. Synonym for go.
The state to switch to
Optional newData: mDT
The data change to insert during the transition
-Returns boolean
transition_
Parameters
newStateOrAction: string
newData: mDT
wasForced: boolean
wasAction: boolean
Returns boolean
valid_
Parameters
action: string
Optional _newData: mDT
Returns boolean
valid_
Parameters
newState: string
Optional _newData: mDT
Returns boolean
valid_
Parameters
newState: string
Optional _newData: mDT
Returns boolean
Generated using TypeDoc
Returns boolean
transition_
Parameters
newStateOrAction: string
newData: mDT
wasForced: boolean
wasAction: boolean
Returns boolean
valid_
Parameters
action: string
Optional _newData: mDT
Returns boolean
valid_
Parameters
newState: string
Optional _newData: mDT
Returns boolean
valid_
Parameters
newState: string
Optional _newData: mDT
Returns boolean