Preparing search index...
The search index is not available
xorca - v
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
xorca
createOrchestrationMachineV3
Function createOrchestrationMachineV3
create
Orchestration
Machine
V3
<
TContext
,
TInput
>
(
config
)
:
OrchestrationMachine
<
AnyActorLogic
>
Type Parameters
TContext
extends
Record
<
string
,
any
>
TInput
extends
Record
<
string
,
any
>
=
Record
<
string
,
any
>
Parameters
config
:
OrchestrationMachineConfigV3
<
TContext
,
TInput
>
Returns
OrchestrationMachine
<
AnyActorLogic
>
xorca
Action
A generic class for defining actions within an XState state machine context. It encapsulates
Cloud
Orchestration
Actor
A specialized Actor class designed for cloud orchestration scenarios. It extends the XState Actor class,
Emit
`Emit` class facilitates the creation and management of typed events within a state machine.
Guard
Represents a condition (guard) within a state machine context using XState. Guards in XState are
Orchestration
Router
Persistable
Actor
A class that extends the functionality of a standard actor with persistence and locking capabilities.
Transition
Manages state transitions within a state machine, allowing configuration of transition conditions, actions, and targets.
IOrchestrate
Cloud
Events
Describes a basic orchestration router interface, including the unique orchestrator name,
IOrchestration
Router
Extends the basic orchestration router interface with additional configuration options,
Basic
Context
Represents the standard context for a state machine, incorporating critical metadata that enhances
Basic
Event
Object
Defines a basic event object structure for a state machine, integrating custom data with standard
Cloud
Orchestration
Actor
Options
Configuration options tailored for a CloudOrchestrationActor, extending the base ActorOptions with cloud-specific features.
Cloud
Orchestration
Middlewares
Interface defining middleware options for a Cloud Orchestration Actor, facilitating customization of event processing and orchestration logic.
Create
Orchestration
Machine
Options
Options configuration for creating an orchestration machine.
Guarded
Transition
V3
Describes configurations for state transitions within the state machine that are contingent on specific conditions
On
Orchestration
Event
Middleware function type for processing CloudEvents.
On
Orchestration
Event
Transformer
Middleware function type for processing CloudEvents.
On
Orchestration
State
Middleware function type for handling orchestration logic based on state and snapshot data.
On
Orchestration
State
Emit
Middleware function type for handling orchestration logic based on state and snapshot data.
Orchestration
Machine
Represents the output of the `createOrchestrationMachine` function.
Orchestration
Machine
Allowed
String
Keys
Type representing allowed string keys in orchestration machine configuration,
Orchestration
Machine
Config
Configuration for an orchestration machine. This defines the machine. It is a subset of
Orchestration
Machine
Config
V3
Represents the configuration schema for an orchestration state machine, encompassing states, transitions,
Orchestration
Machine
With
Version
Defines a version-specific orchestration state machine configuration.
Orchestration
Process
Response
Defines the structure of responses from the orchestration router, including event details,
Orchestration
State
Config
Configuration for an orchestration machine state.
Orchestration
State
Config
V3
Configures individual states within an orchestration machine, including details on state types, transitions,
Orchestration
State
Type
Type representing possible states in an orchestration machine.
Orchestration
Transition
Config
Configuration for transitioning between states in an orchestration machine.
Persistable
Actor
Input
Defines the structure for the input parameters required by the `withPersistance` function.
Pre
Writer
Record
Represents the record structure for pre-writing operations in a unified storage manager context.
Version
Represents the version of a state machine in the format '{number}.{number}.{number}'.
Basic
Actions
A dictionary to reference the basic actions
Internal
Echo
Cloud
Event
Handler
Defines a CloudEventHandler for handling dummy events specifically designed
append
Pre
Writer
Use this as a append pre writer for the unified storage manager
assign
Event
Data
To
Context
assign
Execution
Units
To
Context
assign
Logs
To
Context
assign
Orchestration
Time
To
Context
create
Cloud
Event
Creates a new CloudEvent based on the provided parameters.
create
Cloud
Orchestration
Actor
Factory function for creating instances of CloudOrchestrationActor. This function simplifies the instantiation
create
Orchestration
Handler
Creates an event handler for orchestrating events in xOrca.
create
Orchestration
Init
Handler
Creates an event handler for initializing orchestrations in xOrca.
create
Orchestration
Machine
create
Orchestration
Machine
V2
create
Orchestration
Machine
V3
create
Orchestration
Router
Creates and configures an instance of an orchestration router. This router is responsible for
generate
Short
Uuid
Generates a short UUID by first creating a standard UUID, then hashing it using SHA-256.
internal
Echo
Event
State
Creates an internal echo state to clear the event cache in an orchestrator's memory.
make
Cloud
Event
Subject
Creates a subject string for a given process, name, and version.
orchestrate
Cloud
Events
parse
Cloud
Event
Subject
Parses a subject string and returns an object with processId, name, and version.
with
Basic
Actions
This function adds the default actions to the action list
with
Default
Actions
with
Persistable
Actor
Helper function for managing the lifecycle of a PersistableActor.
Generated using
TypeDoc