Skip to main content

Interface: NexusUpdateWorkflowOptions

nexus.NexusUpdateWorkflowOptions

Options for UpdatableWorkflowHandle.update. The target Workflow (workflow and run IDs) is carried by the handle, and the Update definition or name is passed as the method's first argument, so only the wait stage and the Update ID are supplied here.

The Update's arguments are intersected onto this type by each update overload, so that args is required for an Update that takes arguments and rejected for one that does not.

Workflow Updates as Nexus Operations are experimental.

Properties​

updateId​

• Optional Readonly updateId: string

The Update ID, a unique-per-Workflow-Execution identifier for this Update.

If unset, the Nexus request ID is used as the Update ID. This protects against a retried Nexus request (e.g. after a network failure) spawning a duplicate Update.

waitForStage​

• Readonly waitForStage: "ACCEPTED"

The Update lifecycle stage to wait for before the Update is considered to be backing the Nexus Operation.

Only WorkflowUpdateStage.ACCEPTED is supported: a Nexus Operation backed by an Update is asynchronous, and the Update's outcome is delivered through the operation's completion callback rather than by waiting for it here.