Skip to main content

Interface: WorkflowSignalWithStartOptions<SA>

client.WorkflowSignalWithStartOptions

Type parameters

NameType
SAextends any[] = []

Hierarchy

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.

Inherited from

WorkflowOptions.cronSchedule


followRuns

Optional followRuns: boolean

If set to true, instructs the client to follow the chain of execution before returning a Workflow's result.

Workflow execution is chained if the Workflow has a cron schedule or continues-as-new or configured to retry after failure or timeout.

default true

Inherited from

WorkflowOptions.followRuns


memo

Optional memo: Record<string, any>

Specifies additional non-indexed information in result of list workflow. The type of value can be any object that are serializable by DataConverter.

Inherited from

WorkflowOptions.memo


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.

Inherited from

WorkflowOptions.retry


searchAttributes

Optional searchAttributes: Record<string, string | number | boolean>

Specifies additional indexed information in result of list workflow. The type of value should be a primitive (e.g. string, number, boolean). For dates, use Date.toISOString()

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

Inherited from

WorkflowOptions.searchAttributes


signal

signal: string | SignalDefinition<SA>

SignalDefinition or name of signal


signalArgs

signalArgs: SA

Arguments to invoke the signal handler with


taskQueue

taskQueue: string

Task queue to use for Workflow tasks. It should match a task queue specified when creating a Worker that hosts the Workflow code.

Inherited from

WorkflowOptions.taskQueue


workflowExecutionTimeout

Optional workflowExecutionTimeout: string | number

The time after which workflow execution (which includes run retries and continue as new) is automatically terminated by Temporal service. Do not rely on execution timeout for business level timeouts. It is preferred to use in workflow timers for this purpose.

format ms formatted string or number of milliseconds

Inherited from

WorkflowOptions.workflowExecutionTimeout


workflowId

workflowId: string

Workflow id to use when starting.

Assign a meaningful business id. This ID can be used to ensure starting Workflows is idempotent. Workflow IDs are unique, see also WorkflowOptions.workflowIdReusePolicy

Inherited from

WorkflowOptions.workflowId


workflowIdReusePolicy

Optional workflowIdReusePolicy: WorkflowIdReusePolicy

Specifies server behavior if a completed workflow with the same id exists. Note that under no conditions Temporal allows two workflows with the same namespace and workflow id run simultaneously. ALLOW_DUPLICATE_FAILED_ONLY is a default value. It means that workflow can start if previous run failed or was canceled or terminated. ALLOW_DUPLICATE allows new run independently of the previous run closure status. REJECT_DUPLICATE doesn't allow new run independently of the previous run closure status.

Inherited from

WorkflowOptions.workflowIdReusePolicy


workflowRunTimeout

Optional workflowRunTimeout: string | number

The time after which workflow run is automatically terminated by Temporal service. Do not rely on run timeout for business level timeouts. It is preferred to use in workflow timers for this purpose.

format ms formatted string or number of milliseconds

Inherited from

WorkflowOptions.workflowRunTimeout


workflowTaskTimeout

Optional workflowTaskTimeout: string | number

Maximum execution time of a single workflow task. Default is 10 seconds.

format ms formatted string or number of milliseconds

Inherited from

WorkflowOptions.workflowTaskTimeout