procxy / OptionsValidationError

Class: OptionsValidationError

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

Thrown when a value in ProcxyOptions fails validation before the child process is spawned.

Remarks

Validation runs synchronously at the start of procxy(), so this error is always thrown before any child process is spawned. It is safe to inspect and retry with corrected options.

Validated fields and their constraints:

• timeout: must be a positive number
• retries: must be a non-negative integer
• cwd: must be a path to an existing directory
• env: all values must be strings
• serialization: must be 'json' or 'advanced'
• args: each element must be serializable under the active mode

Example

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

try {
  await procxy(MyWorker, { timeout: -1 }); // negative timeout
} catch (err) {
  if (err instanceof OptionsValidationError) {
    console.error(`Bad option "${err.optionName}": ${err.reason}`);
    // err.optionValue contains the invalid value
  }
}

Extends

• ProcxyError

Constructors

Constructor

new OptionsValidationError(
   optionName, 
   optionValue, 
   reason, 
   context?
): OptionsValidationError;

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

Parameters

Parameter	Type	Description
optionName	string	The name of the option that failed validation (e.g. 'timeout', 'cwd')
optionValue	unknown	The invalid value that was provided
reason	string	Human-readable explanation of what constraint was violated
context?	Record<string, unknown>	-

Returns

OptionsValidationError

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
name	public	string	-	ProcxyError.name	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
optionName	readonly	string	The name of the option that failed validation (e.g. 'timeout', 'cwd')	-	src/shared/errors.ts:293
optionValue	readonly	unknown	The invalid value that was provided	-	src/shared/errors.ts:295
reason	readonly	string	Human-readable explanation of what constraint was violated	-	src/shared/errors.ts:297
stack?	public	string	-	ProcxyError.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.	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