Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/security / / SandboxPeerUnavailableError

Class: SandboxPeerUnavailableError

Defined in: packages/security/src/sandbox/errors.ts:48

Raised when the optional native peer dependency required by an adapter (e.g. isolated-vm, dockerode) is not installed.

Stable

Extends

• GraphorinSandboxError

Constructors

Constructor

new SandboxPeerUnavailableError(
   adapter, 
   peer, 
   installCommand, 
   options?): SandboxPeerUnavailableError;

Defined in: packages/security/src/sandbox/errors.ts:56

Parameters

Parameter	Type
adapter	string
peer	string
installCommand	string
options?	{ cause?: unknown; }
options.cause?	unknown

Returns

SandboxPeerUnavailableError

Overrides

GraphorinSandboxError.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
adapter	readonly	string	undefined	Adapter that requested the peer.	-	-	packages/security/src/sandbox/errors.ts:51
cause?	public	unknown	undefined	-	-	GraphorinSandboxError.cause	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
hint?	readonly	string	undefined	Optional remediation hint (CLI command or doc link).	-	GraphorinSandboxError.hint	packages/security/src/secrets/errors.ts:21
installCommand	readonly	string	undefined	Verbatim install command shown to operators.	-	-	packages/security/src/sandbox/errors.ts:55
kind	readonly	"sandbox-peer-unavailable"	'sandbox-peer-unavailable'	Stable lowercase discriminator. Subclasses fix this to a literal.	GraphorinSandboxError.kind	-	packages/security/src/sandbox/errors.ts:49
message	public	string	undefined	-	-	GraphorinSandboxError.message	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	undefined	-	-	GraphorinSandboxError.name	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
peer	readonly	string	undefined	npm package name that was missing.	-	-	packages/security/src/sandbox/errors.ts:53
stack?	public	string	undefined	-	-	GraphorinSandboxError.stack	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
stackTraceLimit	static	number	undefined	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.	-	GraphorinSandboxError.stackTraceLimit	node_modules/.pnpm/@types+node@22.19.17/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

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

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

GraphorinSandboxError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

GraphorinSandboxError.prepareStackTrace