@temporal-contract/worker / activity
activity
Classes
ActivityDefinitionNotFoundError
Defined in: packages/worker/src/errors.ts:64
Error thrown when an activity definition is not found in the contract
Extends
TaggedErrorInstance<"@temporal-contract/ActivityDefinitionNotFoundError", {activityName:string;availableDefinitions: readonlystring[];message:string; }>
Constructors
Constructor
new ActivityDefinitionNotFoundError(activityName, availableDefinitions?): ActivityDefinitionNotFoundError;Defined in: packages/worker/src/errors.ts:72
Parameters
| Parameter | Type | Default value |
|---|---|---|
activityName | string | undefined |
availableDefinitions | readonly string[] | [] |
Returns
ActivityDefinitionNotFoundError
Overrides
TaggedError(
"@temporal-contract/ActivityDefinitionNotFoundError",
{ name: "ActivityDefinitionNotFoundError" },
)<{
activityName: string;
availableDefinitions: readonly string[];
message: string;
}>.constructorProperties
| Property | Modifier | Type | Inherited from | Defined in |
|---|---|---|---|---|
_tag | readonly | "@temporal-contract/ActivityDefinitionNotFoundError" | TaggedError( "@temporal-contract/ActivityDefinitionNotFoundError", { name: "ActivityDefinitionNotFoundError" }, )._tag | node_modules/.pnpm/unthrown@0.2.0/node_modules/unthrown/dist/index.d.mts:638 |
activityName | readonly | string | TaggedError( "@temporal-contract/ActivityDefinitionNotFoundError", { name: "ActivityDefinitionNotFoundError" }, ).activityName | packages/worker/src/errors.ts:68 |
availableDefinitions | readonly | readonly string[] | TaggedError( "@temporal-contract/ActivityDefinitionNotFoundError", { name: "ActivityDefinitionNotFoundError" }, ).availableDefinitions | packages/worker/src/errors.ts:69 |
cause? | public | unknown | TaggedError( "@temporal-contract/ActivityDefinitionNotFoundError", { name: "ActivityDefinitionNotFoundError" }, ).cause | node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24 |
message | public | string | ActivityInputValidationError.message | node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075 |
name | public | string | TaggedError( "@temporal-contract/ActivityDefinitionNotFoundError", { name: "ActivityDefinitionNotFoundError" }, ).name | node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074 |
stack? | public | string | TaggedError( "@temporal-contract/ActivityDefinitionNotFoundError", { name: "ActivityDefinitionNotFoundError" }, ).stack | node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076 |
ActivityInputValidationError
Defined in: packages/worker/src/errors.ts:85
Error thrown when activity input validation fails
Extends
Constructors
Constructor
new ActivityInputValidationError(activityName, issues): ActivityInputValidationError;Defined in: packages/worker/src/errors.ts:86
Parameters
| Parameter | Type |
|---|---|
activityName | string |
issues | readonly Issue[] |
Returns
Overrides
ValidationError.constructorProperties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
activityName | readonly | string | - | - | packages/worker/src/errors.ts:87 |
category? | readonly | "BENIGN" | null | - | WorkflowOutputValidationError.category | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:113 |
cause? | readonly | Error | - | ActivityOutputValidationError.cause | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:72 |
details? | readonly | unknown[] | null | - | WorkflowOutputValidationError.details | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:111 |
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:78 |
issues | readonly | readonly Issue[] | - | ValidationError.issues | packages/worker/src/errors.ts:38 |
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 | - | WorkflowOutputValidationError.nextRetryDelay | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:112 |
nonRetryable? | readonly | boolean | null | - | WorkflowOutputValidationError.nonRetryable | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:110 |
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 | - | WorkflowOutputValidationError.type | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:109 |
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@24.13.2/node_modules/@types/node/globals.d.ts:68 |
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void;Defined in: node_modules/.pnpm/@types+node@24.13.2/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
ValidationError.captureStackTrace
create()
static create(options): ApplicationFailure;Defined in: node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:130
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:124
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:150
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
prepareStackTrace()
static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/.pnpm/@types+node@24.13.2/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
ValidationError.prepareStackTrace
retryable()
static retryable(
message?,
type?, ...
details): ApplicationFailure;Defined in: node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:139
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
Inherited from
ActivityOutputValidationError
Defined in: packages/worker/src/errors.ts:102
Error thrown when activity output validation fails
Extends
Constructors
Constructor
new ActivityOutputValidationError(activityName, issues): ActivityOutputValidationError;Defined in: packages/worker/src/errors.ts:103
Parameters
| Parameter | Type |
|---|---|
activityName | string |
issues | readonly Issue[] |
Returns
Overrides
ValidationError.constructorProperties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
activityName | readonly | string | - | - | packages/worker/src/errors.ts:104 |
category? | readonly | "BENIGN" | null | - | ValidationError.category | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:113 |
cause? | readonly | Error | - | ValidationError.cause | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:72 |
details? | readonly | unknown[] | null | - | ValidationError.details | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:111 |
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:78 |
issues | readonly | readonly Issue[] | - | ValidationError.issues | packages/worker/src/errors.ts:38 |
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:112 |
nonRetryable? | readonly | boolean | null | - | ValidationError.nonRetryable | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:110 |
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:109 |
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@24.13.2/node_modules/@types/node/globals.d.ts:68 |
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void;Defined in: node_modules/.pnpm/@types+node@24.13.2/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
ValidationError.captureStackTrace
create()
static create(options): ApplicationFailure;Defined in: node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:130
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:124
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:150
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
prepareStackTrace()
static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/.pnpm/@types+node@24.13.2/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
ValidationError.prepareStackTrace
retryable()
static retryable(
message?,
type?, ...
details): ApplicationFailure;Defined in: node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:139
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
Inherited from
ApplicationFailure
Defined in: node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:108
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:
typeis set toerror.constructor?.name ?? error.namemessageis set toerror.messagenonRetryableis set to falsedetailsare set to null- 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
Constructors
Constructor
new ApplicationFailure(
message?,
type?,
nonRetryable?,
details?,
cause?,
nextRetryDelay?,
category?): ApplicationFailure;Defined in: node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:117
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.constructorProperties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
category? | readonly | "BENIGN" | null | - | - | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:113 |
cause? | readonly | Error | - | ActivityOutputValidationError.cause | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:72 |
details? | readonly | unknown[] | null | - | - | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:111 |
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.18.1/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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:112 |
nonRetryable? | readonly | boolean | null | - | - | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:110 |
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:109 |
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@24.13.2/node_modules/@types/node/globals.d.ts:68 |
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void;Defined in: node_modules/.pnpm/@types+node@24.13.2/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.captureStackTracecreate()
static create(options): ApplicationFailure;Defined in: node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:130
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:124
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:150
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
prepareStackTrace()
static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/.pnpm/@types+node@24.13.2/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
TemporalFailure.prepareStackTraceretryable()
static retryable(
message?,
type?, ...
details): ApplicationFailure;Defined in: node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:139
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
abstract ValidationError
Defined in: packages/worker/src/errors.ts:34
Base class for the contract's runtime validation failures — workflow and activity input/output, plus signal/query/update payloads.
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 failing field path is carried in the human-readable message (see summarizeIssues). The raw issues remain available as a property for in-process inspection.
See issue #251.
Extends
Extended by
ActivityInputValidationErrorActivityOutputValidationErrorQueryInputValidationErrorQueryOutputValidationErrorSignalInputValidationErrorUpdateInputValidationErrorUpdateOutputValidationErrorWorkflowInputValidationErrorWorkflowOutputValidationError
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
category? | readonly | "BENIGN" | null | - | WorkflowOutputValidationError.category | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:113 |
cause? | readonly | Error | - | ActivityOutputValidationError.cause | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:72 |
details? | readonly | unknown[] | null | - | WorkflowOutputValidationError.details | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:111 |
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:78 |
issues | readonly | readonly Issue[] | - | - | packages/worker/src/errors.ts:38 |
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 | - | WorkflowOutputValidationError.nextRetryDelay | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:112 |
nonRetryable? | readonly | boolean | null | - | WorkflowOutputValidationError.nonRetryable | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:110 |
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 | - | WorkflowOutputValidationError.type | node_modules/.pnpm/@temporalio+common@1.18.1/node_modules/@temporalio/common/lib/failure.d.ts:109 |
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@24.13.2/node_modules/@types/node/globals.d.ts:68 |
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void;Defined in: node_modules/.pnpm/@types+node@24.13.2/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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:130
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:124
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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:150
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
ApplicationFailure.nonRetryable
prepareStackTrace()
static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/.pnpm/@types+node@24.13.2/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.18.1/node_modules/@temporalio/common/lib/failure.d.ts:139
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
Inherited from
Type Aliases
ActivitiesHandler
type ActivitiesHandler<TContract> = TContract["activities"] extends Record<string, ActivityDefinition> ? ActivitiesImplementations<TContract["activities"]> : object & UnionToIntersection<{ [TWorkflow in keyof TContract["workflows"]]: TContract["workflows"][TWorkflow]["activities"] extends Record<string, ActivityDefinition> ? ActivitiesImplementations<TContract["workflows"][TWorkflow]["activities"]> : {} }[keyof TContract["workflows"]]>;Defined in: packages/worker/src/activity.ts:121
Activities handler ready for Temporal's Worker.create({ activities }).
Flat shape: every activity (global + all workflow-local) lives at the root of the returned map. See the doc comment on ContractResultActivitiesImplementations for why the input you write is nested by workflow while this output is flat.
Type Parameters
| Type Parameter |
|---|
TContract extends ContractDefinition |
Functions
declareActivitiesHandler()
function declareActivitiesHandler<TContract>(options): ActivitiesHandler<TContract>;Defined in: packages/worker/src/activity.ts:201
Create a typed activities handler with automatic validation and Result pattern.
This wraps all activity implementations with:
- Validation at network boundaries
AsyncResult<T, ApplicationFailure>pattern for explicit error handling- Automatic conversion from Result to Promise (throwing on Error)
TypeScript ensures ALL activities (global + workflow-specific) are implemented.
Use this to create the activities object for the Temporal Worker.
Type Parameters
| Type Parameter |
|---|
TContract extends ContractDefinition |
Parameters
| Parameter | Type |
|---|---|
options | DeclareActivitiesHandlerOptions<TContract> |
Returns
ActivitiesHandler<TContract>
Example
import { declareActivitiesHandler, ApplicationFailure } from '@temporal-contract/worker/activity';
import { fromPromise } from 'unthrown';
import myContract from './contract';
export const activities = declareActivitiesHandler({
contract: myContract,
activities: {
// Activity returns AsyncResult instead of throwing.
sendEmail: (args) =>
fromPromise(
emailService.send(args),
(error) =>
// Wrap technical errors in ApplicationFailure. `nonRetryable`
// is per-instance: set it to true on permanent failures so
// Temporal stops retrying immediately.
ApplicationFailure.create({
type: 'EMAIL_SEND_FAILED',
message: 'Failed to send email',
nonRetryable: false,
cause: error instanceof Error ? error : undefined,
}),
).map(() => ({ sent: true })),
},
});
// Use with Temporal Worker
import { Worker } from '@temporalio/worker';
const worker = await Worker.create({
workflowsPath: require.resolve('./workflows'),
activities: activities,
taskQueue: contract.taskQueue,
});Remarks
The wrapper accepts implementations in the AsyncResult<T, ApplicationFailure> shape and produces ordinary Promise-returning Temporal handlers (err(...) → thrown ApplicationFailure; ok(...) → output validated against the contract and resolved; defect → original cause re-thrown). It does not hide Temporal's @temporalio/activity runtime: inside the body you can still call Context.current() from @temporalio/activity to access heartbeats (heartbeat(details), heartbeatDetails), activity info (attempt number, workflow IDs), and the async-completion task token. See the "Working with the Activity Context" section of the worker implementation guide for end-to-end examples.