Skip to main content

Interface: BaseWorkflowOptions

common.BaseWorkflowOptions

Properties​

cronSchedule​

• Optional cronSchedule: string

Optional cron schedule for Workflow. If a cron schedule is specified, the Workflow will run as a cron based on the schedule. The scheduling will be based on UTC time. The schedule for the next run only happens after the current run is completed/failed/timeout. If a RetryPolicy is also supplied, and the Workflow failed or timed out, the Workflow will be retried based on the retry policy. While the Workflow is retrying, it won't schedule its next run. If the next schedule is due while the Workflow is running (or retrying), then it will skip that schedule. Cron Workflow will not stop until it is terminated or cancelled (by returning temporal.CanceledError). https://crontab.guru/ is useful for testing your cron expressions.

memo​

• Optional memo: Record<string, unknown>

Specifies additional non-indexed information to attach to the Workflow Execution. The values can be anything that is serializable by DataConverter.

priority​

• Optional priority: Priority

Priority of a workflow

retry​

• Optional retry: RetryPolicy

Controls how a Workflow Execution is retried.

By default, Workflow Executions are not retried. Do not override this behavior unless you know what you're doing. More information.

searchAttributes​

• Optional searchAttributes: SearchAttributes

Specifies additional indexed information to attach to the Workflow Execution. More info: https://docs.temporal.io/docs/typescript/search-attributes

Values are always converted using JsonPayloadConverter, even when a custom data converter is provided.

Deprecated

Use typedSearchAttributes instead.

staticDetails​

• Optional staticDetails: string

General fixed details for this workflow execution that may appear in UI/CLI. This can be in Temporal markdown format and can span multiple lines.

User metadata is a new API and susceptible to change.

staticSummary​

• Optional staticSummary: string

A single-line fixed summary for this workflow execution that may appear in the UI/CLI. This can be in single-line Temporal markdown format.

User metadata is a new API and susceptible to change.

typedSearchAttributes​

• Optional typedSearchAttributes: TypedSearchAttributes | SearchAttributePair[]

Specifies additional indexed information to attach to the Workflow Execution. More info: https://docs.temporal.io/docs/typescript/search-attributes

Values are always converted using JsonPayloadConverter, even when a custom data converter is provided. Note that search attributes are not encoded, as such, do not include any sensitive information.

If both searchAttributes and typedSearchAttributes are provided, conflicting keys will be overwritten by typedSearchAttributes.

workflowIdConflictPolicy​

• Optional workflowIdConflictPolicy: WorkflowIdConflictPolicy

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

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

Default

{@link WorkflowIdConflictPolicy.WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED}

workflowIdReusePolicy​

• Optional workflowIdReusePolicy: WorkflowIdReusePolicy

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

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

Default

{@link WorkflowIdReusePolicy.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE}