Class: TemporalFailure

common.TemporalFailure

Represents failures that can cross Workflow and Activity boundaries.

Never extend this class or any of its children.

The only child class you should ever throw from your code is ApplicationFailure.

Hierarchy

• Error

  ↳ TemporalFailure

  ↳↳ ServerFailure

  ↳↳ ApplicationFailure

  ↳↳ CancelledFailure

  ↳↳ TerminatedFailure

  ↳↳ TimeoutFailure

  ↳↳ ActivityFailure

  ↳↳ ChildWorkflowFailure

  ↳↳ WorkflowExecutionAlreadyStartedError

Constructors

constructor

• new TemporalFailure(message?, cause?): TemporalFailure

Parameters

Name	Type
message?	null | string
cause?	Error

Returns

TemporalFailure

Overrides

Error.constructor

Properties

cause

• Optional Readonly cause: Error

Overrides

Error.cause

---

failure

• Optional failure: IFailure

The original failure that constructed this error.

Only present if this error was generated from an external operation.

---

message

• message: string

Inherited from

Error.message

---

name

• name: string

Inherited from

Error.name

---

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

Name	Type
err	Error
stackTraces	CallSite[]

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

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace