Class Actor<TEvent, TState, TContext>

An "actor" is a client-side representation of a machine instance.

This is intended to closely mimic the notion of an XState actor and should be compatible with any XState utilities that accept actors.

Type Parameters

TEvent extends Exclude<Event, string> = any
TState extends StateValue = any
TContext extends Record<string, unknown> = any

Hierarchy

Actor

Index

Constructors

constructor

new Actor<TEvent, TState, TContext>(client, machineName, instanceName, state, signal?): Actor<TEvent, TState, TContext>
Type Parameters
- TEvent extends {
  type: string;
  [key: string]: unknown;
  } = any
- TState extends string | {
  [key: string]: components["schemas"]["StateValue"] | undefined;
  } = any
- TContext extends Record<string, unknown> = any
Parameters
- client: StateBackedClient
- machineName: string
- instanceName: string
- state: {
      done: boolean;
      publicContext?: {
          [key: string]: unknown;
      };
      state: string | {
          [key: string]: components["schemas"]["StateValue"] | undefined;
      };
      tags: string[];
      ts: number;
  }
  - done: boolean
    
    Description
    Is the state machine complete
  - Optional publicContext?: {
    [key: string]: unknown;
    }
    
    Description
    The public context of the machine instance.
    
    This includes all context under the public key.
    - [key: string]: unknown
  - state: string | {
    [key: string]: components["schemas"]["StateValue"] | undefined;
    }
  - tags: string[]
    
    Description
    Array of tags for the current states
  - ts: number
    
    Description
    Timestamp for when the state was created
- Optional signal: AbortSignal
Returns Actor<TEvent, TState, TContext>
- Defined in work/client-js/client-js/src/index.ts:2270

Properties

`Private` client

client: StateBackedClient

`Readonly` id

id: string

The actor's id ("machineName/instanceName")

inFlightEvents

inFlightEvents: (TEvent | ExtractType<TEvent> | TEvent["type"])[] = []

`Private` instanceName

instanceName: string

`Private` latestReceivedTs

latestReceivedTs: number = 0

`Private` machineName

machineName: string

`Private` `Optional` signal

signal?: AbortSignal

`Private` state

state: ActorState<TState, TContext>

`Private` subscribers

subscribers: Observer<ActorState<TState, TContext>>[] = []

`Private` unsubscribe

unsubscribe: Unsubscribe

Methods

[observable]

[observable](): Actor<TEvent, TState, TContext>
Returns Actor<TEvent, TState, TContext>
- Defined in work/client-js/client-js/src/index.ts:2415

`Private` _subscribeToRemoteState

_subscribeToRemoteState(): void
Returns void
- Defined in work/client-js/client-js/src/index.ts:2294

getSnapshot

getSnapshot(): ActorState<TState, TContext>
Get the current state.

Returns ActorState<TState, TContext>
the current state of the instance.
- Defined in work/client-js/client-js/src/index.ts:2411

`Private` processStateUpdate

processStateUpdate(state, forceTrigger?): void
Parameters
- state: {
      done: boolean;
      publicContext?: {
          [key: string]: unknown;
      };
      state: string | {
          [key: string]: components["schemas"]["StateValue"] | undefined;
      };
      tags: string[];
      ts: number;
  }
  - done: boolean
    
    Description
    Is the state machine complete
  - Optional publicContext?: {
    [key: string]: unknown;
    }
    
    Description
    The public context of the machine instance.
    
    This includes all context under the public key.
    - [key: string]: unknown
  - state: string | {
    [key: string]: components["schemas"]["StateValue"] | undefined;
    }
  - tags: string[]
    
    Description
    Array of tags for the current states
  - ts: number
    
    Description
    Timestamp for when the state was created
- forceTrigger: boolean = false
Returns void
- Defined in work/client-js/client-js/src/index.ts:2317

`Private` reportError

reportError(err): void
Parameters
- err: Error
Returns void
- Defined in work/client-js/client-js/src/index.ts:2288

send

send(event): void
Send an event to the actor.
Parameters
- event: TEvent | ExtractType<TEvent> | TEvent["type"]
  
  the event to send
Returns void
- Defined in work/client-js/client-js/src/index.ts:2390

`Private` setState

setState(state): void
Parameters
- state: ActorState<TState, TContext>
Returns void
- Defined in work/client-js/client-js/src/index.ts:2281

subscribe(next, error?, complete?): Subscription
Subscribe to the actor's state. This will call the callback with the current state and any time the state changes.
Parameters
- next: ((value) => void)
  - - (value): void
    - Parameters
      
      value: ActorState<TState, TContext>
      
      Returns void
- Optional error: ((error) => void)
  - - (error): void
    - Parameters
      
      error: any
      
      Returns void
- Optional complete: (() => void)
  - - (): void
    - Returns void
Returns Subscription
- a function to unsubscribe from state updates
- Defined in work/client-js/client-js/src/index.ts:2347
subscribe(observer): Subscription
Parameters
- observer: Observer<ActorState<TState, TContext>>
Returns Subscription
- Defined in work/client-js/client-js/src/index.ts:2352

Class Actor<TEvent, TState, TContext>

Type Parameters

TEvent extends Exclude<Event, string> = any

TState extends StateValue = any

TContext extends Record<string, unknown> = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TEvent extends { type: string; [key: string]: unknown; } = any

TState extends string | { [key: string]: components["schemas"]["StateValue"] | undefined; } = any

TContext extends Record<string, unknown> = any

Parameters

client: StateBackedClient

machineName: string

instanceName: string

state: { done: boolean; publicContext?: { [key: string]: unknown; }; state: string | { [key: string]: components["schemas"]["StateValue"] | undefined; }; tags: string[]; ts: number; }

done: boolean

Description

Optional publicContext?: { [key: string]: unknown; }

Description

[key: string]: unknown

state: string | { [key: string]: components["schemas"]["StateValue"] | undefined; }

tags: string[]

Description

ts: number

Description

Optional signal: AbortSignal

Returns Actor<TEvent, TState, TContext>

Properties

Private client

Readonly id

inFlightEvents

Private instanceName

Private latestReceivedTs

Private machineName

Private Optional signal

Private state

Private subscribers

Private unsubscribe

Methods

[observable]

Returns Actor<TEvent, TState, TContext>

Private _subscribeToRemoteState

Returns void

getSnapshot

Returns ActorState<TState, TContext>

Private processStateUpdate

Parameters

state: { done: boolean; publicContext?: { [key: string]: unknown; }; state: string | { [key: string]: components["schemas"]["StateValue"] | undefined; }; tags: string[]; ts: number; }

done: boolean

Description

Optional publicContext?: { [key: string]: unknown; }

Description

[key: string]: unknown

state: string | { [key: string]: components["schemas"]["StateValue"] | undefined; }

tags: string[]

Description

ts: number

Description

forceTrigger: boolean = false

Returns void

Private reportError

Parameters

err: Error

Returns void

send

Parameters

event: TEvent | ExtractType<TEvent> | TEvent["type"]

Returns void

Private setState

Parameters

state: ActorState<TState, TContext>

Returns void

subscribe

Parameters

TEvent extends {
type: string;
[key: string]: unknown;
} = any

TState extends string | {
[key: string]: components["schemas"]["StateValue"] | undefined;
} = any

state: {
done: boolean;
publicContext?: {
[key: string]: unknown;
};
state: string | {
[key: string]: components["schemas"]["StateValue"] | undefined;
};
tags: string[];
ts: number;
}

`Optional` publicContext?: {
[key: string]: unknown;
}

state: string | {
[key: string]: components["schemas"]["StateValue"] | undefined;
}

`Optional` signal: AbortSignal

`Private` client

`Readonly` id

`Private` instanceName

`Private` latestReceivedTs

`Private` machineName

`Private` `Optional` signal

`Private` state

`Private` subscribers

`Private` unsubscribe

`Private` _subscribeToRemoteState

`Private` processStateUpdate

state: {
done: boolean;
publicContext?: {
[key: string]: unknown;
};
state: string | {
[key: string]: components["schemas"]["StateValue"] | undefined;
};
tags: string[];
ts: number;
}

`Optional` publicContext?: {
[key: string]: unknown;
}

state: string | {
[key: string]: components["schemas"]["StateValue"] | undefined;
}

`Private` reportError

`Private` setState

`Optional` error: ((error) => void)

`Optional` complete: (() => void)