Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InvokeConfig<TContext, TEvent>

Type Parameters

Hierarchy

  • InvokeConfig

Index

Properties

autoForward?: boolean

If true, events sent to the parent service will be forwarded to the invoked service.

Default: false

data?: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>

Data from the parent machine's context to set as the (partial or full) context for the invoked child machine.

Data should be mapped to match the child machine's context shape.

forward?: boolean
deprecated

Use autoForward property instead of forward. Support for forward will get removed in the future.

id?: string

The unique identifier for the invoked machine. If not specified, this will be the machine's own id, or the URL (from src).

onDone?: string | TransitionConfig<TContext, DoneInvokeEvent<any>> | TransitionConfig<TContext, DoneInvokeEvent<any>>[]

The transition to take upon the invoked child machine reaching its final top-level state.

onError?: string | TransitionConfig<TContext, DoneInvokeEvent<any>> | TransitionConfig<TContext, DoneInvokeEvent<any>>[]

The transition to take upon the invoked child machine sending an error event.

src: string | StateMachine<any, any, any, { context: any; value: any }> | InvokeSourceDefinition | InvokeCreator<TContext, TEvent, any>

The source of the machine to be invoked, or the machine itself.

Generated using TypeDoc