procxy / TimeoutError

Class: TimeoutError

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

Thrown when a proxied method call or the INIT handshake exceeds the configured timeout.

Remarks

The child process is NOT killed when this error is thrown. Only the Promise for the timed-out call is rejected. The child continues running and future calls succeed once it becomes responsive again. If you need to shut down an unresponsive child, call $terminate() explicitly after catching this error.

The timeout clock starts when the IPC call is dispatched and stops when the response arrives. It does not account for queueing: if retries is set, the full timeout is applied per attempt, so total wait = timeout * (retries + 1).

Example

import { procxy, TimeoutError } from 'procxy';
import { SlowWorker } from './slow-worker.js';

const worker = await procxy(SlowWorker, { timeout: 5_000, retries: 0 });
try {
  await worker.longOperation();
} catch (err) {
  if (err instanceof TimeoutError) {
    console.error(`${err.methodName} timed out after ${err.timeoutMs}ms`);
    await worker.$terminate(); // optional: kill the stuck child
  }
}

Extends

• ProcxyError

Constructors

Constructor

new TimeoutError(
   methodName, 
   timeoutMs, 
   context?
): TimeoutError;

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

Parameters

Parameter	Type	Description
methodName	string	Name of the method or phase (e.g. 'init') that timed out
timeoutMs	number	Timeout threshold in milliseconds as configured via the timeout field in ProcxyOptions
context?	Record<string, unknown>	-

Returns

TimeoutError

Overrides

ProcxyError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
cause?	public	unknown	-	ProcxyError.cause	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
context?	readonly	Record<string, unknown>	-	ProcxyError.context	src/shared/errors.ts:45
message	public	string	-	ProcxyError.message	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
methodName	readonly	string	Name of the method or phase (e.g. 'init') that timed out	-	src/shared/errors.ts:87
name	public	string	-	ProcxyError.name	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
stack?	public	string	-	ProcxyError.stack	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
timeoutMs	readonly	number	Timeout threshold in milliseconds as configured via the timeout field in ProcxyOptions	-	src/shared/errors.ts:89
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.	ProcxyError.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

ProcxyError.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

ProcxyError.prepareStackTrace