Class: CodeSandboxError

Defined in: src/provider-contract/codeSandbox.ts:46

A code-session operation refused — before anything was sent, or because what came back could not be trusted as the answer.

Carries the path, sizes and limits as data. Never a file's contents and never a command's text: those are the two things a code session holds that an error message must not repeat, because error messages reach logs, traces and the model.

Extends

Error

Constructors

Constructor

new CodeSandboxError(reason, message, details?): CodeSandboxError

Defined in: src/provider-contract/codeSandbox.ts:57

Parameters

reason

CodeSandboxRefusal

message

string

details?

bytes?

number

limit?

number

path?

string

Returns

CodeSandboxError

Overrides

Error.constructor

Properties

bytes?

readonly optional bytes?: number

Defined in: src/provider-contract/codeSandbox.ts:53

The size that was measured, in bytes, when the refusal is about size.

cause?

optional cause?: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

code

readonly code: "ERR_CODE_SANDBOX"

Defined in: src/provider-contract/codeSandbox.ts:47

limit?

readonly optional limit?: number

Defined in: src/provider-contract/codeSandbox.ts:55

The limit that size was held to, in bytes.

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

path?

readonly optional path?: string

Defined in: src/provider-contract/codeSandbox.ts:51

The session path involved, when there was one.

reason

readonly reason: CodeSandboxRefusal

Defined in: src/provider-contract/codeSandbox.ts:49

What was refused.

stack?

optional stack?: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

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.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: 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();

static prepareStackTrace(err, stackTraces): any

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

CodeSandboxError

On this page