Class WorkflowInstanceAbstract

constructor

• new WorkflowInstance(): WorkflowInstance

  Returns WorkflowInstance

id

delete

• delete(): Promise<void>

  Delete the instance and its stored state.

  Returns Promise<void>

pause

• pause(): Promise<void>

  Pause the instance.

  Returns Promise<void>

restart

• restart(options?: WorkflowInstanceRestartOptions): Promise<void>

  Restart the instance. Optionally restart from a specific step, preserving cached results for all steps before it.

  Parameters

  • Optionaloptions: WorkflowInstanceRestartOptions

    Options for the restart, including an optional step to restart from.

  Returns Promise<void>

resume

• resume(): Promise<void>

  Resume the instance. If it is already running, an error will be thrown.

  Returns Promise<void>

sendEvent

• sendEvent(__namedParameters: { payload: unknown; type: string }): Promise<void>

  Send an event to this instance.

  Parameters

  • __namedParameters: { payload: unknown; type: string }

  Returns Promise<void>

status

• status(): Promise<InstanceStatus>

  Returns the current status of the instance.

  Returns Promise<InstanceStatus>

subscribe

• subscribe(
      options?: WorkflowInstanceSubscribeOptions,
  ): Promise<WorkflowInstanceSubscription>

  Subscribe to events emitted by this instance.

  Parameters

  • Optionaloptions: WorkflowInstanceSubscribeOptions

  Returns Promise<WorkflowInstanceSubscription>

terminate

• terminate(options?: WorkflowInstanceTerminateOptions): Promise<void>

  Terminate the instance. If it is errored, terminated or complete, an error will be thrown.

  Parameters

  • Optionaloptions: WorkflowInstanceTerminateOptions

    Options for termination, including whether registered rollback handlers should run.

  Returns Promise<void>