Interface: DurableWorkflowOptions
Properties
description?
optionaldescription?:string
executionTimeout?
optionalexecutionTimeout?:Duration
Bounds the whole continue-as-new and retry chain (11 §2.20); config.executionTimeout.
failureErrorTypes?
optionalfailureErrorTypes?: readonly (...args) =>Error[]
Error classes that fail the run instead of the workflow task (11 §2.25).
input?
optionalinput?:SchemaLike
open?
optionalopen?: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?
optionalqueries?:boolean
signals?
optionalsignals?:boolean
updates?
optionalupdates?:boolean
output?
optionaloutput?:SchemaLike
queries?
optionalqueries?: readonlyQueryDefinition<unknown,unknown>[]
Declared queries; ctx.handleQuery answers them.
retry?
optionalretry?:WorkflowRetryOptions
Run-level retry (11 §2.17); lowered to config.retry.
runTimeout?
optionalrunTimeout?:Duration
Bounds one run; config.timeout.
signals?
optionalsignals?: readonly (SignalDefinition<never> |SignalDefinition<unknown>)[]
standalone?
optionalstandalone?: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?
optionaltaskQueue?:string
Default managed.
title?
optionaltitle?:string
Display name of the standalone workflow.
trigger?
optionaltrigger?:TriggerSpec
Lowers to the trigger node of the standalone workflow (default internal:api).
updates?
optionalupdates?: readonlyUpdateDefinition<unknown,unknown>[]
Declared updates; ctx.handleUpdate handles them.
versioningBehavior?
optionalversioningBehavior?:"PINNED"|"AUTO_UPGRADE"
PINNED (default) or AUTO_UPGRADE (11 §2.27); lowered to config.versioningBehavior.
workflowTaskTimeout?
optionalworkflowTaskTimeout?:Duration
The replay budget of one workflow task, at most 120 s; config.workflowTaskTimeout.