Skip to main content

Class: WorkflowFailedError

client.WorkflowFailedError

Thrown by the client while waiting on Workflow execution result if execution completes with failure.

The failure type will be set in the cause attribute.

For example if the workflow is cancelled, cause will be set to CancelledFailure.

Hierarchy

  • Error

    WorkflowFailedError

Constructors

constructor

new WorkflowFailedError(message, cause, retryState)

Parameters

NameType
messagestring
causeundefined | TemporalFailure
retryStateRetryState

Overrides

Error.constructor

Properties

cause

Readonly cause: undefined | TemporalFailure


message

message: string

Inherited from

Error.message


name

Readonly name: string

Overrides

Error.name


retryState

Readonly retryState: RetryState


stack

Optional stack: string

Inherited from

Error.stack


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

see https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace