Skip to main content

Interface: DurableWorkflowOptions

Properties​

description?​

optional description?: string


executionTimeout?​

optional executionTimeout?: Duration

Bounds the whole continue-as-new and retry chain (11 §2.20); config.executionTimeout.


failureErrorTypes?​

optional failureErrorTypes?: readonly (...args) => Error[]

Error classes that fail the run instead of the workflow task (11 §2.25).


input?​

optional input?: SchemaLike


open?​

optional open?: object

Accept names the interface does not declare (11 §2.29), written as interface.open. lower() also sets a kind open when the declaring module registers a default handler for it.

queries?​

optional queries?: boolean

signals?​

optional signals?: boolean

updates?​

optional updates?: boolean


output?​

optional output?: SchemaLike


queries?​

optional queries?: readonly QueryDefinition<unknown, unknown>[]

Declared queries; ctx.handleQuery answers them.


retry?​

optional retry?: WorkflowRetryOptions

Run-level retry (11 §2.17); lowered to config.retry.


runTimeout?​

optional runTimeout?: Duration

Bounds one run; config.timeout.


signals?​

optional signals?: readonly (SignalDefinition<never> | SignalDefinition<unknown>)[]


standalone?​

optional standalone?: boolean

Whether the function is a workflow of its own (07 §4): by default, when it declares a trigger or nothing in the project embeds it with wf.codeWorkflow.


taskQueue?​

optional taskQueue?: string

Default managed.


title?​

optional title?: string

Display name of the standalone workflow.


trigger?​

optional trigger?: TriggerSpec

Lowers to the trigger node of the standalone workflow (default internal:api).


updates?​

optional updates?: readonly UpdateDefinition<unknown, unknown>[]

Declared updates; ctx.handleUpdate handles them.


versioningBehavior?​

optional versioningBehavior?: "PINNED" | "AUTO_UPGRADE"

PINNED (default) or AUTO_UPGRADE (11 §2.27); lowered to config.versioningBehavior.


workflowTaskTimeout?​

optional workflowTaskTimeout?: Duration

The replay budget of one workflow task, at most 120 s; config.workflowTaskTimeout.