Hybrid Compute

Appearance

Documentation / @hybrid-compute/worker / WorkerTaskError

Class: WorkerTaskError ​

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

Why a worker task failed: the worker script replied with an error, the reply was unusable, the worker crashed or couldn't start, the input couldn't be sent, the timeout passed, or the backend was closed.

A task cancelled with an AbortSignal rejects with the signal's reason instead, so a WorkerTaskError always means something went wrong.

Example ​

ts
try {
  await threaded.runTask('resizeImage', blob);
} catch (error) {
  if (error instanceof WorkerTaskError) {
    console.warn(`${error.taskName} failed`, error.detail);
  }
}

Extends ​

Constructors ​

Constructor ​

ts
new WorkerTaskError(
   taskName: string,
   message: string,
   details?: {
  cause?: unknown;
  detail?: unknown;
}): WorkerTaskError;

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

Parameters ​

taskName ​

string

The name of the task that failed.

message ​

string

What went wrong.

details? ​

The worker script's error value and the underlying error, where there is one.

cause? ​

unknown

detail? ​

unknown

Returns ​

WorkerTaskError

Overrides ​

ts
Error.constructor;

Properties ​

cause? ​

ts
optional cause?: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from ​

ts
Error.cause;

detail? ​

ts
readonly optional detail?: unknown;

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

The worker script's error value as it was sent, if it sent one.

message ​

ts
message: string;

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

Inherited from ​

ts
Error.message;

name ​

ts
name: string;

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

Inherited from ​

ts
Error.name;

stack? ​

ts
optional stack?: string;

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

Inherited from ​

ts
Error.stack;

taskName ​

ts
readonly taskName: string;

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

The name of the task that failed.

stackTraceLimit ​

ts
static stackTraceLimit: number;

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

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 ​

ts
Error.stackTraceLimit;

Methods ​

captureStackTrace() ​

ts
static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

Defined in: 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.

js
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:

js
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 ​

ts
Error.captureStackTrace;

prepareStackTrace() ​

ts
static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

Parameters ​

err ​

Error

stackTraces ​

CallSite[]

Returns ​

any

See ​

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

Inherited from ​

ts
Error.prepareStackTrace;