@ue-too/being-portable / PortableMachine
介面: PortableMachine
定義於: being-portable/src/api-types.ts:63
A loaded machine: an ordinary being state machine plus its definition, snapshot and restore.
Extends
StateMachine<PortableEvents,PortableContext,string,PortableOutputs>
屬性
context
readonlycontext:PortableContext
定義於: being-portable/src/api-types.ts:71
Read-only access to the machine's live context object. Optional so existing StateMachine implementations remain valid; TemplateStateMachine always provides it. Intended for tooling/introspection (e.g. visualizers evaluating guards against the current context) — mutate state through events, not through this reference.
覆寫了
StateMachine.context
currentState
currentState:
string
定義於: being/dist/interface.d.ts:220
繼承自
StateMachine.currentState
definition
readonlydefinition:MachineDefinition
定義於: being-portable/src/api-types.ts:70
The upgraded, normalized document, frozen.
possibleStates
possibleStates:
string[]
定義於: being/dist/interface.d.ts:199
繼承自
StateMachine.possibleStates
states
states:
Record<States,State<EventPayloadMapping,Context,stringextendsStates?string:States,EventOutputMapping>>
定義於: being/dist/interface.d.ts:191
繼承自
StateMachine.states
方法
happens()
呼叫簽章
happens<
K>(...args):EventResult<string,Kextendsnever?PortableOutputs[K<K>] :void>
定義於: being/dist/interface.d.ts:188
型別參數
K
K extends never
參數
args
...EventArgs<PortableEvents, K>
回傳
EventResult<string, K extends never ? PortableOutputs[K<K>] : void>
繼承自
StateMachine.happens
呼叫簽章
happens<
K>(...args):EventResult<string,unknown>
定義於: being/dist/interface.d.ts:189
型別參數
K
K extends string
參數
args
...EventArgs<PortableEvents, K>
回傳
EventResult<string, unknown>
繼承自
StateMachine.happens
onEventResult()?
optionalonEventResult(callback):void| () =>void
定義於: being/dist/interface.d.ts:216
Subscribe to every event result. Optional so existing StateMachine implementations remain valid; TemplateStateMachine always provides it. Returns a disposer on implementations that support one. Disposing during a dispatch takes effect starting with the next dispatch, not the one in progress — see EventResultCallback for the exact snapshot-iteration semantics.
參數
callback
EventResultCallback<PortableEvents, PortableContext, string>
回傳
void | () => void
繼承自
StateMachine.onEventResult
onHappens()
onHappens(
callback):void| () =>void
定義於: being/dist/interface.d.ts:207
Subscribe to every happens() call, before the state handles it. Returns a disposer on implementations that support one. Disposing during a dispatch takes effect starting with the next dispatch, not the one in progress — see EventResultCallback for the exact snapshot-iteration semantics.
參數
callback
(args, context) => void
回傳
void | () => void
繼承自
StateMachine.onHappens
onStateChange()
onStateChange(
callback):void| () =>void
定義於: being/dist/interface.d.ts:198
Subscribe to state changes. Returns a disposer on implementations that support one. Disposing during a dispatch takes effect starting with the next dispatch, not the one in progress — see EventResultCallback for the exact snapshot-iteration semantics.
參數
callback
StateChangeCallback<string>
回傳
void | () => void
繼承自
StateMachine.onStateChange
reset()
reset():
void
定義於: being/dist/interface.d.ts:217
回傳
void
繼承自
StateMachine.reset
restore()
restore(
snapshot,options?):RestoreResult
定義於: being-portable/src/api-types.ts:74
參數
snapshot
unknown
options?
mode?
回傳
setContext()
setContext(
context):void
定義於: being/dist/interface.d.ts:190
參數
context
回傳
void
繼承自
StateMachine.setContext
snapshot()
snapshot():
MachineSnapshot
定義於: being-portable/src/api-types.ts:73
Throws while the machine is handling an event.
回傳
start()
start():
void
定義於: being/dist/interface.d.ts:218
回傳
void
繼承自
StateMachine.start
switchTo()
switchTo(
state):void
定義於: being/dist/interface.d.ts:178
參數
state
string
回傳
void
繼承自
StateMachine.switchTo
wrapup()
wrapup():
void
定義於: being/dist/interface.d.ts:219
回傳
void
繼承自
StateMachine.wrapup