activity <a class="header-anchor" href="#activity" aria-label="Permalink to &quot;activity&quot;">​

create()

static create(options): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:131

Create a new ApplicationFailure.

By default, will be retryable (unless its type is included in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type
`options`	`ApplicationFailureOptions`

Returns

Inherited from

fromError()

static fromError(error, overrides?): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:125

Create a new ApplicationFailure from an Error object.

First calls ensureApplicationFailure | `ensureApplicationFailure(error)` and then overrides any fields provided in overrides.

Parameters

Parameter	Type
`error`	`unknown`
`overrides?`	`ApplicationFailureOptions`

Returns

Inherited from

nonRetryable()

static nonRetryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:151

Get a new ApplicationFailure with the nonRetryable flag set to true.

When thrown from an Activity or Workflow, the Activity or Workflow will not be retried (even if type is not listed in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

ActivityOutputValidationError

retryable()

static retryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:140

Get a new ApplicationFailure with the nonRetryable flag set to false. Note that this error will still not be retried if its type is included in RetryPolicy.nonRetryableErrorTypes.

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type (used by RetryPolicy.nonRetryableErrorTypes)
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Error thrown when activity output validation fails.

Extends

ValidationError

Constructors

Constructor

new ActivityOutputValidationError(activityName, issues): ActivityOutputValidationError;

Defined in: packages/worker/src/errors.ts:165

Parameters

Parameter	Type
`activityName`	`string`
`issues`	readonly `Issue`[]

Returns

Overrides

ValidationError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`activityName`	`readonly`	`string`	-	-	packages/worker/src/errors.ts:166
`category?`	`readonly`	`"BENIGN"` \| `null`	-	`ValidationError`.`category`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:114
`cause?`	`readonly`	`Error`	-	`ValidationError`.`cause`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:72
`details?`	`readonly`	`unknown`[] \| `null`	-	`ValidationError`.`details`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:112
`direction`	`readonly`	`"output"`	-	-	packages/worker/src/errors.ts:163
`failure?`	`public`	`IFailure`	The original failure that constructed this error. Only present if this error was generated from an external operation.	`ValidationError`.`failure`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:78
`issues`	`readonly`	readonly `Issue`[]	-	`ValidationError`.`issues`	packages/worker/src/errors.ts:64
`message`	`public`	`string`	-	`ValidationError`.`message`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
`name`	`public`	`string`	-	`ValidationError`.`name`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
`nextRetryDelay?`	`readonly`	`any`	-	`ValidationError`.`nextRetryDelay`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:113
`nonRetryable?`	`readonly`	`boolean` \| `null`	-	`ValidationError`.`nonRetryable`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:111
`stack?`	`public`	`string`	-	`ValidationError`.`stack`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
`type?`	`readonly`	`string` \| `null`	-	`ValidationError`.`type`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:110
`stackTraceLimit`	`static`	`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.	`ValidationError`.`stackTraceLimit`	node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:52

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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

create()

static create(options): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:131

Create a new ApplicationFailure.

By default, will be retryable (unless its type is included in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type
`options`	`ApplicationFailureOptions`

Returns

Inherited from

fromError()

static fromError(error, overrides?): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:125

Create a new ApplicationFailure from an Error object.

First calls ensureApplicationFailure | `ensureApplicationFailure(error)` and then overrides any fields provided in overrides.

Parameters

Parameter	Type
`error`	`unknown`
`overrides?`	`ApplicationFailureOptions`

Returns

Inherited from

nonRetryable()

static nonRetryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:151

Get a new ApplicationFailure with the nonRetryable flag set to true.

When thrown from an Activity or Workflow, the Activity or Workflow will not be retried (even if type is not listed in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

retryable()

static retryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:140

Get a new ApplicationFailure with the nonRetryable flag set to false. Note that this error will still not be retried if its type is included in RetryPolicy.nonRetryableErrorTypes.

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type (used by RetryPolicy.nonRetryableErrorTypes)
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns

ValidationError.retryable

Inherited from

ApplicationFailure

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:109

ApplicationFailures are used to communicate application-specific failures in Workflows and Activities.

The type property is matched against RetryPolicy.nonRetryableErrorTypes to determine if an instance of this error is retryable. Another way to avoid retrying is by setting the nonRetryable flag to true.

In Workflows, if you throw a non-ApplicationFailure, the Workflow Task will fail and be retried. If you throw an ApplicationFailure, the Workflow Execution will fail.

In Activities, you can either throw an ApplicationFailure or another Error to fail the Activity Task. In the latter case, the Error will be converted to an ApplicationFailure. The conversion is done as following:

type is set to error.constructor?.name ?? error.name
message is set to error.message
nonRetryable is set to false
details are set to null
cause is set to error.cause when it is an Error
stack trace is copied from the original error

When an Activity Execution fails, the ApplicationFailure from the last Activity Task will be the cause of the ActivityFailure thrown in the Workflow.

Extends

TemporalFailure

Extended by

ValidationError

Constructors

Constructor

new ApplicationFailure(
   message?, 
   type?, 
   nonRetryable?, 
   details?, 
   cause?, 
   nextRetryDelay?, 
   category?
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:118

Alternatively, use fromError or create.

Parameters

Parameter	Type
`message?`	`string` \| `null`
`type?`	`string` \| `null`
`nonRetryable?`	`boolean` \| `null`
`details?`	`unknown`[] \| `null`
`cause?`	`Error`
`nextRetryDelay?`	`any`
`category?`	`"BENIGN"` \| `null`

Returns

Overrides

TemporalFailure.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`category?`	`readonly`	`"BENIGN"` \| `null`	-	-	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:114
`cause?`	`readonly`	`Error`	-	`ActivityOutputValidationError`.`cause`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:72
`details?`	`readonly`	`unknown`[] \| `null`	-	-	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:112
`failure?`	`public`	`IFailure`	The original failure that constructed this error. Only present if this error was generated from an external operation.	`TemporalFailure.failure`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:78
`message`	`public`	`string`	-	`TemporalFailure.message`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
`name`	`public`	`string`	-	`TemporalFailure.name`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
`nextRetryDelay?`	`readonly`	`any`	-	-	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:113
`nonRetryable?`	`readonly`	`boolean` \| `null`	-	-	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:111
`stack?`	`public`	`string`	-	`TemporalFailure.stack`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
`type?`	`readonly`	`string` \| `null`	-	-	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:110
`stackTraceLimit`	`static`	`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.	`TemporalFailure.stackTraceLimit`	node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:52

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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

TemporalFailure.captureStackTrace

create()

static create(options): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:131

Create a new ApplicationFailure.

By default, will be retryable (unless its type is included in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type
`options`	`ApplicationFailureOptions`

Returns

fromError()

static fromError(error, overrides?): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:125

Create a new ApplicationFailure from an Error object.

First calls ensureApplicationFailure | `ensureApplicationFailure(error)` and then overrides any fields provided in overrides.

Parameters

Parameter	Type
`error`	`unknown`
`overrides?`	`ApplicationFailureOptions`

Returns

nonRetryable()

static nonRetryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:151

Get a new ApplicationFailure with the nonRetryable flag set to true.

When thrown from an Activity or Workflow, the Activity or Workflow will not be retried (even if type is not listed in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

TemporalFailure.prepareStackTrace

retryable()

static retryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:140

Get a new ApplicationFailure with the nonRetryable flag set to false. Note that this error will still not be retried if its type is included in RetryPolicy.nonRetryableErrorTypes.

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type (used by RetryPolicy.nonRetryableErrorTypes)
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns

ContractErrorDataValidationError

ContractError

Defined in: packages/contract/dist/errors-impl-D7p9uupF.d.mts:45

A typed domain error declared on a contract's errors map.

One class covers every declared error; the errorName field is the per-error discriminant (it equals the key in the contract's errors map and the ApplicationFailure.type on the wire). Narrow a union with it:

if (result.isErr() && result.error instanceof ContractError) {
  switch (result.error.errorName) {
    case "PaymentDeclined":
      result.error.data; // { reason: string }
  }
}

The unthrown _tag ("@temporal-contract/ContractError") discriminates a ContractError from the other tagged errors in a Result's error channel (e.g. via result.match({ errCases: (m) => m.with(P.tag("@temporal-contract/ContractError"), …) })); errorName then narrows to the concrete declared error.

Extends

ContractError_base<{ cause?: unknown; data: TData; errorName: TName; }>

Type Parameters

Type Parameter	Default type
`TName` extends `string`	`string`
`TData`	`unknown`

Constructors

Constructor

new ContractError<TName, TData>(args): ContractError<TName, TData>;

Defined in: packages/contract/dist/errors-impl-D7p9uupF.d.mts:52

Parameters

Parameter	Type
`args`	{ `cause?`: `unknown`; `data`: `TData`; `errorName`: `TName`; `message`: `string`; }
`args.cause?`	`unknown`
`args.data`	`TData`
`args.errorName`	`TName`
`args.message`	`string`

Returns

ContractError<TName, TData>

Overrides

ContractError_base<{
  / Declared error name — the ApplicationFailure.type discriminator. /
  errorName: TName;
  / Structured payload validated against the declared data schema. /
  data: TData;
  cause?: unknown;
}>.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`_tag`	`readonly`	`"@temporal-contract/ContractError"`	-	`ContractError_base._tag`	node_modules/.pnpm/unthrown@5.11.0/node_modules/unthrown/dist/index.d.mts:2332
`cause?`	`public`	`unknown`	-	`ActivityDefinitionNotFoundError`.`cause`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
`data`	`readonly`	`TData`	Structured payload validated against the declared `data` schema.	`ContractError_base.data`	packages/contract/dist/errors-impl-D7p9uupF.d.mts:49
`errorName`	`readonly`	`TName`	Declared error name — the `ApplicationFailure.type` discriminator.	`ContractError_base.errorName`	packages/contract/dist/errors-impl-D7p9uupF.d.mts:47
`message`	`public`	`string`	-	`ContractError_base.message`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
`name`	`public`	`string`	-	`ContractError_base.name`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
`stack?`	`public`	`string`	-	`ContractError_base.stack`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

ContractErrorDataValidationError

Defined in: packages/worker/src/errors.ts:280

Error thrown when a contract-declared error's data payload fails validation against its declared schema at the Temporal boundary — a deterministic contract-misuse bug, so the failure is terminal (nonRetryable) like the other validation errors. (A ContractError whose name isn't declared at all is a ContractMisuseError.)

Extends

ValidationError

Constructors

Constructor

new ContractErrorDataValidationError(errorName, issues): ContractErrorDataValidationError;

Defined in: packages/worker/src/errors.ts:281

Parameters

Parameter	Type
`errorName`	`string`
`issues`	readonly `Issue`[]

Returns

Overrides

ValidationError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`category?`	`readonly`	`"BENIGN"` \| `null`	-	`ValidationError`.`category`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:114
`cause?`	`readonly`	`Error`	-	`ValidationError`.`cause`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:72
`details?`	`readonly`	`unknown`[] \| `null`	-	`ValidationError`.`details`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:112
`errorName`	`readonly`	`string`	-	-	packages/worker/src/errors.ts:282
`failure?`	`public`	`IFailure`	The original failure that constructed this error. Only present if this error was generated from an external operation.	`ValidationError`.`failure`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:78
`issues`	`readonly`	readonly `Issue`[]	-	`ValidationError`.`issues`	packages/worker/src/errors.ts:64
`message`	`public`	`string`	-	`ValidationError`.`message`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
`name`	`public`	`string`	-	`ValidationError`.`name`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
`nextRetryDelay?`	`readonly`	`any`	-	`ValidationError`.`nextRetryDelay`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:113
`nonRetryable?`	`readonly`	`boolean` \| `null`	-	`ValidationError`.`nonRetryable`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:111
`stack?`	`public`	`string`	-	`ValidationError`.`stack`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
`type?`	`readonly`	`string` \| `null`	-	`ValidationError`.`type`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:110
`stackTraceLimit`	`static`	`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.	`ValidationError`.`stackTraceLimit`	node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:52

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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

create()

static create(options): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:131

Create a new ApplicationFailure.

By default, will be retryable (unless its type is included in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type
`options`	`ApplicationFailureOptions`

Returns

Inherited from

fromError()

static fromError(error, overrides?): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:125

Create a new ApplicationFailure from an Error object.

First calls ensureApplicationFailure | `ensureApplicationFailure(error)` and then overrides any fields provided in overrides.

Parameters

Parameter	Type
`error`	`unknown`
`overrides?`	`ApplicationFailureOptions`

Returns

Inherited from

nonRetryable()

static nonRetryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:151

Get a new ApplicationFailure with the nonRetryable flag set to true.

When thrown from an Activity or Workflow, the Activity or Workflow will not be retried (even if type is not listed in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

retryable()

static retryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:140

Get a new ApplicationFailure with the nonRetryable flag set to false. Note that this error will still not be retried if its type is included in RetryPolicy.nonRetryableErrorTypes.

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type (used by RetryPolicy.nonRetryableErrorTypes)
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns

ValidationError.retryable

Inherited from

ContractMisuseError

Defined in: packages/worker/src/errors.ts:334

Error thrown when code misuses the contract surface — a deterministic programming bug, never a payload problem. Outside the sandbox it is the startup failure of declareActivitiesHandler (missing, conflicting or ambiguous implementations); at an activity boundary it is a ContractError whose name the activity doesn't declare. Inside the workflow sandbox it fires at one of two points with two different runtime consequences:

Binding a signal/query/update handler for a name the contract doesn't declare, using an async-validating schema where Temporal requires synchronous validation, throwing an undeclared ContractError, or continuing as new into an undeclared workflow. These throw from inside the running implementation — handleSignal/handleQuery/handleUpdate execute there, after Temporal has already invoked the workflow function — so the throw is classified as a normal workflow failure and fails the Workflow Execution terminally with a clear message, the same way throw context.errors.X(...) does. A plain Error at that point would instead be classified as a Workflow Task failure and retried indefinitely, leaving the execution silently Running forever — this is the case ValidationError's siblings all guard against, and it's genuinely true here.
Reaching an activity that no options cover (see buildRawActivitiesProxy in internal.ts). This one is different: it throws at module top level, inside declareWorkflow itself, before Temporal ever invokes the workflow function. A throw there is a Workflow Task failure regardless of the error class — nonRetryable never reaches a FailWorkflowExecution command from this path — so it stalls the workflow via indefinite workflow-task retry exactly like the plain TypeError it replaces. That is deliberate (see activity-bounds.ts); the value here is a typed, named, greppable failure, not a different retry outcome — and TypedWorker.create's registration check, which imports the workflows module, fails worker startup on it.

Extends ValidationError for family consistency with its siblings (a schema-validation failure at the wire boundary), even though the second case above doesn't share their retry-outcome rationale.

Carries no schema issues (the misuse is structural, not a payload validation failure), so the issues array is always empty.

Extends

ValidationError

Constructors

Constructor

new ContractMisuseError(message): ContractMisuseError;

Defined in: packages/worker/src/errors.ts:335

Parameters

Parameter	Type
`message`	`string`

Returns

ContractMisuseError

Overrides

ValidationError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`category?`	`readonly`	`"BENIGN"` \| `null`	-	`ValidationError`.`category`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:114
`cause?`	`readonly`	`Error`	-	`ValidationError`.`cause`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:72
`details?`	`readonly`	`unknown`[] \| `null`	-	`ValidationError`.`details`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:112
`failure?`	`public`	`IFailure`	The original failure that constructed this error. Only present if this error was generated from an external operation.	`ValidationError`.`failure`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:78
`issues`	`readonly`	readonly `Issue`[]	-	`ValidationError`.`issues`	packages/worker/src/errors.ts:64
`message`	`public`	`string`	-	`ValidationError`.`message`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
`name`	`public`	`string`	-	`ValidationError`.`name`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
`nextRetryDelay?`	`readonly`	`any`	-	`ValidationError`.`nextRetryDelay`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:113
`nonRetryable?`	`readonly`	`boolean` \| `null`	-	`ValidationError`.`nonRetryable`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:111
`stack?`	`public`	`string`	-	`ValidationError`.`stack`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
`type?`	`readonly`	`string` \| `null`	-	`ValidationError`.`type`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:110
`stackTraceLimit`	`static`	`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.	`ValidationError`.`stackTraceLimit`	node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:52

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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

create()

static create(options): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:131

Create a new ApplicationFailure.

By default, will be retryable (unless its type is included in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type
`options`	`ApplicationFailureOptions`

Returns

Inherited from

fromError()

static fromError(error, overrides?): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:125

Create a new ApplicationFailure from an Error object.

First calls ensureApplicationFailure | `ensureApplicationFailure(error)` and then overrides any fields provided in overrides.

Parameters

Parameter	Type
`error`	`unknown`
`overrides?`	`ApplicationFailureOptions`

Returns

Inherited from

nonRetryable()

static nonRetryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:151

Get a new ApplicationFailure with the nonRetryable flag set to true.

When thrown from an Activity or Workflow, the Activity or Workflow will not be retried (even if type is not listed in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

retryable()

static retryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:140

Get a new ApplicationFailure with the nonRetryable flag set to false. Note that this error will still not be retried if its type is included in RetryPolicy.nonRetryableErrorTypes.

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type (used by RetryPolicy.nonRetryableErrorTypes)
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns

ValidationError.retryable

Inherited from

`abstract` ValidationError

Defined in: packages/worker/src/errors.ts:60

Base class for the contract's runtime validation failures — workflow and activity input/output, plus query/update payloads. (Invalid signal payloads are not errors: signals are fire-and-forget, so the worker drops and logs them instead of failing the execution.)

These extend Temporal's ApplicationFailure with nonRetryable: true rather than a plain Error, and that distinction is load-bearing. The TypeScript SDK classifies a non-TemporalFailure thrown from workflow code as a Workflow Task failure — presumed to be a transient code bug or non-determinism — and retries the task indefinitely, leaving the execution silently Running forever (it looks like the worker "hung"). Only a TemporalFailure such as ApplicationFailure fails the Workflow Execution terminally. The same logic applies at the activity boundary, where Temporal's default retry policy has unlimited attempts: a plain Error would retry forever too.

Contract validation failures are deterministic — the schema is static, so bad input/output never becomes valid on replay or retry — so they are surfaced as non-retryable, failing fast with a clear error instead of an infinite retry loop.

The concrete subclass name is passed through as the failure type, so it stays discriminable after crossing Temporal's serialization boundary (where the JS class identity is lost) via failure.type. The message carries only the failing field paths (see summarizeIssues) because it is stored in history unencrypted; the full issues — schema messages included, which may echo payload values — ride details[0] as { message, path } records, which payload codecs do encrypt. The raw issues also remain available as a property for in-process inspection.

See issue #251.

Extends

ApplicationFailure

Extended by

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`category?`	`readonly`	`"BENIGN"` \| `null`	-	`WorkflowInputValidationError`.`category`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:114
`cause?`	`readonly`	`Error`	-	`ActivityOutputValidationError`.`cause`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:72
`details?`	`readonly`	`unknown`[] \| `null`	-	`WorkflowInputValidationError`.`details`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:112
`failure?`	`public`	`IFailure`	The original failure that constructed this error. Only present if this error was generated from an external operation.	`ApplicationFailure`.`failure`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:78
`issues`	`readonly`	readonly `Issue`[]	-	-	packages/worker/src/errors.ts:64
`message`	`public`	`string`	-	`ApplicationFailure`.`message`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
`name`	`public`	`string`	-	`ApplicationFailure`.`name`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
`nextRetryDelay?`	`readonly`	`any`	-	`WorkflowInputValidationError`.`nextRetryDelay`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:113
`nonRetryable?`	`readonly`	`boolean` \| `null`	-	`WorkflowInputValidationError`.`nonRetryable`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:111
`stack?`	`public`	`string`	-	`ApplicationFailure`.`stack`	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
`type?`	`readonly`	`string` \| `null`	-	`WorkflowInputValidationError`.`type`	node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:110
`stackTraceLimit`	`static`	`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.	`ApplicationFailure`.`stackTraceLimit`	node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:52

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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

ApplicationFailure.captureStackTrace

create()

static create(options): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:131

Create a new ApplicationFailure.

By default, will be retryable (unless its type is included in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type
`options`	`ApplicationFailureOptions`

Returns

ApplicationFailure.create

Inherited from

fromError()

static fromError(error, overrides?): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:125

Create a new ApplicationFailure from an Error object.

First calls ensureApplicationFailure | `ensureApplicationFailure(error)` and then overrides any fields provided in overrides.

Parameters

Parameter	Type
`error`	`unknown`
`overrides?`	`ApplicationFailureOptions`

Returns

ApplicationFailure.fromError

Inherited from

nonRetryable()

static nonRetryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:151

Get a new ApplicationFailure with the nonRetryable flag set to true.

When thrown from an Activity or Workflow, the Activity or Workflow will not be retried (even if type is not listed in RetryPolicy.nonRetryableErrorTypes).

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns

ApplicationFailure.nonRetryable

Inherited from

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.20.4/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

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

Inherited from

ApplicationFailure.prepareStackTrace

retryable()

static retryable(
   message?, 
   type?, 
   ...details
): ApplicationFailure;

Defined in: node_modules/.pnpm/@temporalio+common@1.24.0/node_modules/@temporalio/common/lib/failure.d.ts:140

Get a new ApplicationFailure with the nonRetryable flag set to false. Note that this error will still not be retried if its type is included in RetryPolicy.nonRetryableErrorTypes.

Parameters

Parameter	Type	Description
`message?`	`string` \| `null`	Optional error message
`type?`	`string` \| `null`	Optional error type (used by RetryPolicy.nonRetryableErrorTypes)
...`details?`	`unknown`[]	Optional details about the failure. Serialized by the Worker's PayloadConverter.

Returns