Skip to main content

Class: TemporalClientError

Defined in: src/errors/temporal-client-error.ts:6

Error thrown by the client, facade and schedule services when an underlying Temporal SDK call fails. Message text is unchanged from earlier releases; the original error is now preserved on cause so details are not lost.

Extends​

  • Error

Constructors​

Constructor​

new TemporalClientError(message, cause?): TemporalClientError

Defined in: src/errors/temporal-client-error.ts:16

Parameters​

message​

string

cause?​

unknown

Returns​

TemporalClientError

Overrides​

Error.constructor

Properties​

cause?​

readonly optional cause?: unknown

Defined in: src/errors/temporal-client-error.ts:8

The original error (or thrown value) that triggered this error.

grpcCode?​

readonly optional grpcCode?: number

Defined in: src/errors/temporal-client-error.ts:12

gRPC status code of the original error, when it carried one.

grpcDetails?​

readonly optional grpcDetails?: string

Defined in: src/errors/temporal-client-error.ts:14

gRPC details string of the original error, when it carried one.

message​

message: string

Defined in: website/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

Error.message

name​

name: string

Defined in: website/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

Error.name

originalName?​

readonly optional originalName?: string

Defined in: src/errors/temporal-client-error.ts:10

Constructor name of the original error, e.g. ServiceError.

stack?​

optional stack?: string

Defined in: website/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

Error.stack

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

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()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

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​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

Error.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace