State Backed
Preparing search index...
The search index is not available
@statebacked/machine
@statebacked/machine
XStateActorRef
Interface XStateActorRef<TEvent, TEmitted>
Actor reference.
Type Parameters
TEvent
extends
XStateEventObject
TEmitted
=
any
Hierarchy
XStateSubscribable
<
TEmitted
>
XStateInteropObservable
<
TEmitted
>
XStateActorRef
Index
Properties
[observable]
get
Snapshot
id
send
stop?
toJSON?
Methods
subscribe
Properties
[observable]
[observable]
:
(
(
)
=>
XStateInteropSubscribable
<
TEmitted
>
)
Type declaration
(
)
:
XStateInteropSubscribable
<
TEmitted
>
Returns
XStateInteropSubscribable
<
TEmitted
>
get
Snapshot
get
Snapshot
:
(
(
)
=>
TEmitted
)
Type declaration
(
)
:
TEmitted
Returns
TEmitted
id
id
:
string
send
send
:
XStateSender
<
TEvent
>
Optional
stop
stop
?:
(
(
)
=>
void
)
Type declaration
(
)
:
void
Returns
void
Optional
toJSON
toJSON
?:
(
(
)
=>
any
)
Type declaration
(
)
:
any
Returns
any
Methods
subscribe
subscribe
(
observer
)
:
XStateSubscription
Parameters
observer
:
XStateObserver
<
TEmitted
>
Returns
XStateSubscription
subscribe
(
next
,
error
?
,
complete
?
)
:
XStateSubscription
Parameters
next
:
(
(
value
)
=>
void
)
(
value
)
:
void
Parameters
value
:
TEmitted
Returns
void
Optional
error
:
(
(
error
)
=>
void
)
(
error
)
:
void
Parameters
error
:
any
Returns
void
Optional
complete
:
(
(
)
=>
void
)
(
)
:
void
Returns
void
Returns
XStateSubscription
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
[observable]
get
Snapshot
id
send
stop
toJSON
subscribe
State Backed
State Backed Docs
Github
@statebacked/machine
AnyXState
Event
Object
AnyXState
State
Machine
XState
Actor
Context
XState
Actor
Ref
XState
Behavior
XState
Interop
Observable
XState
Interop
Subscribable
XState
Observer
XState
Subscribable
XState
Subscription
Allow
Read
Allow
Write
Anonymous
Auth
Context
Default
Auth
Context
Default
Event
Ephemeral
Spawn
Options
Event
Event
Write
Request
Initialization
Write
Request
Inter
Machine
Auth
Context
Persistent
Actor
Ref
Persistent
Instance
Descriptor
Read
Request
Spawn
Options
State
Path
State
Value
Upgrade
Context
Upgrade
State
Write
Request
XState
Event
XState
Event
Object
XState
Invoke
Callback
XState
Receiver
XState
Sender
XState
Spawnable
persistent
Invocable
Source
send
To
spawn
Ephemeral
Instance
spawn
Persistent
Instance
Generated using
TypeDoc
Actor reference.