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

  ↳↳ NexusOperationFailure

  ↳↳ 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

---

stackTraceLimit

▪ Static stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace

▸ prepareStackTrace(err, stackTraces): any

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace