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): WorkflowFailedError

Parameters​

NameType
messagestring
causeundefined | TemporalFailure
retryStateRetryState

Returns​

WorkflowFailedError

Overrides​

Error.constructor

Properties​

cause​

• Readonly cause: undefined | TemporalFailure

Overrides​

Error.cause

message​

• message: string

Inherited from​

Error.message

name​

• name: string

Inherited from​

Error.name

retryState​

• Readonly retryState: RetryState

stack​

• Optional stack: string

Inherited from​

Error.stack

prepareStackTrace​

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

Optional override for formatting stack traces

See

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

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

See

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

Inherited from​

Error.prepareStackTrace

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Methods​

captureStackTrace​

▸ captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace