Skip to main content

Variable: WorkflowIdReusePolicy

const WorkflowIdReusePolicy: object

Defined in: node_modules/@temporalio/common/lib/workflow-options.d.ts:19

Defines what happens when trying to start a Workflow with the same ID as a Closed Workflow.

See WorkflowOptions.workflowIdConflictPolicy for what happens when trying to start a Workflow with the same ID as a Running Workflow.

Concept: Workflow Id Reuse Policy

Note: It is not possible to have two actively running Workflows with the same ID.

Type Declaration​

ALLOW_DUPLICATE​

readonly ALLOW_DUPLICATE: "ALLOW_DUPLICATE"

The Workflow can be started if the previous Workflow is in a Closed state.

Default​

ALLOW_DUPLICATE_FAILED_ONLY​

readonly ALLOW_DUPLICATE_FAILED_ONLY: "ALLOW_DUPLICATE_FAILED_ONLY"

The Workflow can be started if the previous Workflow is in a Closed state that is not Completed.

REJECT_DUPLICATE​

readonly REJECT_DUPLICATE: "REJECT_DUPLICATE"

The Workflow cannot be started.

TERMINATE_IF_RUNNING​

readonly TERMINATE_IF_RUNNING: "TERMINATE_IF_RUNNING"

Terminate the current Workflow if one is already running; otherwise allow reusing the Workflow ID.

Deprecated​

Use WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE instead, and set WorkflowOptions.workflowIdConflictPolicy to WorkflowIdConflictPolicy.WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING. When using this option, WorkflowOptions.workflowIdConflictPolicy must be left unspecified.

WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE​

readonly WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE: "ALLOW_DUPLICATE"

Deprecated​

Use ALLOW_DUPLICATE instead.

WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY​

readonly WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY: "ALLOW_DUPLICATE_FAILED_ONLY"

Deprecated​

Use ALLOW_DUPLICATE_FAILED_ONLY instead.

WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE​

readonly WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE: "REJECT_DUPLICATE"

Deprecated​

Use REJECT_DUPLICATE instead.

WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING​

readonly WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING: "TERMINATE_IF_RUNNING"

Deprecated​

Use TERMINATE_IF_RUNNING instead.

WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED​

readonly WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED: undefined

No need to use this. If a WorkflowIdReusePolicy is set to this, or is not set at all, the default value will be used.

Deprecated​

Either leave property undefined, or use ALLOW_DUPLICATE instead.