Skip to main content

Interface: WorkflowInfo

workflow.WorkflowInfo

Workflow Execution information

Properties

attempt

attempt: number

Starts at 1 and increments for every retry if there is a retryPolicy


continuedFromExecutionRunId

Optional continuedFromExecutionRunId: string

The last Run Id in this Execution Chain


cronSchedule

Optional cronSchedule: string

Cron Schedule for this Execution. Set via WorkflowOptions.cronSchedule.


cronScheduleToScheduleInterval

Optional cronScheduleToScheduleInterval: number

Milliseconds between Cron Runs


executionExpirationTime

Optional executionExpirationTime: Date

Time at which the Workflow Execution expires


executionTimeoutMs

Optional executionTimeoutMs: number

Milliseconds after which the Workflow Execution is automatically terminated by Temporal Server. Set via WorkflowOptions.workflowExecutionTimeout.


firstExecutionRunId

firstExecutionRunId: string

Run Id of the first Run in this Execution Chain


historyLength

historyLength: number

Length of Workflow history up until the current Workflow Task.

This value changes during the lifetime of an Execution.

You may safely use this information to decide when to continueAsNew.


lastFailure

Optional lastFailure: TemporalFailure

Failure from the previous Run (present when this Run is a retry, or the last Run of a Cron Workflow failed)


lastResult

Optional lastResult: unknown

Result from the previous Run (present if this is a Cron Workflow or was Continued As New).

An array of values, since other SDKs may return multiple values from a Workflow.


memo

Optional memo: Record<string, unknown>

Non-indexed information attached to the Workflow Execution


namespace

namespace: string

Namespace this Workflow is executing in


parent

Optional parent: ParentWorkflowInfo

Parent Workflow info (present if this is a Child Workflow)


retryPolicy

Optional retryPolicy: RetryPolicy

Retry Policy for this Execution. Set via WorkflowOptions.retry.


runId

runId: string

ID of a single Workflow run


runTimeoutMs

Optional runTimeoutMs: number

Milliseconds after which the Workflow Run is automatically terminated by Temporal Server. Set via WorkflowOptions.workflowRunTimeout.


searchAttributes

searchAttributes: SearchAttributes

Indexed information attached to the Workflow Execution

This value may change during the lifetime of an Execution.


taskQueue

taskQueue: string

Task queue this Workflow is executing on


taskTimeoutMs

taskTimeoutMs: number

Maximum execution time of a Workflow Task in milliseconds. Set via WorkflowOptions.workflowTaskTimeout.


unsafe

unsafe: UnsafeWorkflowInfo


workflowId

workflowId: string

ID of the Workflow, this can be set by the client during Workflow creation. A single Workflow may run multiple times e.g. when scheduled with cron.


workflowType

workflowType: string

Workflow function's name