Type Alias WorkflowInvocationOptions<Context>

Options for workflow invocations.

Allows overriding Temporal Activity options for this workflow.

type WorkflowInvocationOptions<
    Context extends WorkflowContext = WorkflowContext,
> = {
    activityOptions?: TemporalActivityOptions;
    context?: DeepPartial<Context>;
    detached?: boolean;
}

Properties

activityOptions?: TemporalActivityOptions

Temporal activity options for this invocation (overrides the workflow's default activity options).

context?: DeepPartial<Context>

Allow to overwrite properties of the "context" of workflows when called in tests environments.

detached?: boolean

Configures whether this workflow runs detached:

detached=true maps to ParentClosePolicy.ABANDON: if parent closes before child, the child keeps executing.
detached=false maps to ParentClosePolicy.TERMINATE: if parent closes before child, the child is terminated.