procxy / SerializationError

Class: SerializationError

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

Thrown when a constructor argument, method argument, or return value cannot be serialized across the IPC boundary.

Remarks

In 'json' mode (the default), all values must be JSON.stringify-able. This means undefined, functions, Symbol, BigInt, Date, Map, Set, Buffer, and class instances (other than plain objects) will throw unless they happen to be JSON-compatible.

In 'advanced' mode, all values must be V8-structured-clone-compatible (see V8Serializable). Functions and Symbols still cause this error.

The context_ property names the serialization site ("constructor arguments", "constructor arguments[0]", etc.) for precise debugging without needing a stack trace.

Example

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

try {
  // Will throw: functions are not JSON-serializable
  const w = await procxy(MyWorker, './worker.js', undefined, () => {});
} catch (err) {
  if (err instanceof SerializationError) {
    console.error(`Serialization failed at ${err.context_}:`, err.value);
  }
}

Extends

• ProcxyError

Constructors

Constructor

new SerializationError(
   value, 
   context_, 
   context?
): SerializationError;

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

Parameters

Parameter	Type	Description
value	unknown	The value that failed serialization
context_	string	Description of where in the call the failure occurred (e.g. "constructor arguments[0]")
context?	Record<string, unknown>	-

Returns

SerializationError

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
context_	readonly	string	Description of where in the call the failure occurred (e.g. "constructor arguments[0]")	-	src/shared/errors.ts:246
message	public	string	-	ProcxyError.message	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
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
value	readonly	unknown	The value that failed serialization	-	src/shared/errors.ts:244
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