procxy / ProcxyError

Class: ProcxyError

Defined in: src/shared/errors.ts:42

Base class for all errors thrown by Procxy.

Remarks

Every error thrown by the procxy library extends ProcxyError. Catching this base class lets you distinguish library errors from unrelated runtime errors without importing each subclass.

All subclasses capture a clean stack trace pointing to the call site via Error.captureStackTrace, so the error message and stack are not polluted by internal library frames.

Example

import { procxy, ProcxyError } from 'procxy';
import { MyWorker } from './worker.js';

try {
  const worker = await procxy(MyWorker);
  await worker.doWork();
} catch (err) {
  if (err instanceof ProcxyError) {
    console.error('Procxy error:', err.message, err.context);
  } else {
    throw err; // unrelated error — re-throw
  }
}

See

• TimeoutError — method call exceeded timeout
• ChildCrashedError — child process exited unexpectedly
• SerializationError — argument or return value is not serializable
• ModuleResolutionError — module path could not be determined
• OptionsValidationError — invalid option value passed to procxy()

Extends

• Error

Extended by

• TimeoutError
• ModuleResolutionError
• ChildCrashedError
• SerializationError
• OptionsValidationError

Constructors

Constructor

new ProcxyError(message, context?): ProcxyError;

Defined in: src/shared/errors.ts:43

Parameters

Parameter	Type
message	string
context?	Record<string, unknown>

Returns

ProcxyError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
cause?	public	unknown	-	Error.cause	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
context?	readonly	Record<string, unknown>	-	-	src/shared/errors.ts:45
message	public	string	-	Error.message	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
name	public	string	-	Error.name	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
stack?	public	string	-	Error.stack	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
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.	Error.stackTraceLimit	node_modules/.pnpm/@types+node@26.6.2/node_modules/@types/node/globals.d.ts:67

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@26.6.2/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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace