Skip to content

Classes

GitHubAppNotInstalledError

The Chainguard GitHub App is not installed on the GitHub account being linked. Install it at installUrl, then call enableWorkspaces again.

new GitHubAppNotInstalledError(installUrl, detail?): GitHubAppNotInstalledError

string

string = ""

GitHubAppNotInstalledError

SandboxError.constructor

optional cause?: unknown

The cause of the error.

SandboxError.cause


readonly installUrl: string


message: string

SandboxError.message


name: string

SandboxError.name


optional stack?: string

SandboxError.stack


static stackTraceLimit: 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.

SandboxError.stackTraceLimit

static captureStackTrace(targetObject, constructorOpt?): void

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();

object

Function

void

SandboxError.captureStackTrace

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

object

Function

void

SandboxError.captureStackTrace


static isError(error): error is Error

Indicates whether the argument provided is a built-in Error instance or not.

unknown

error is Error

SandboxError.isError

static isError(value): value is Error

Check if a value is an instance of Error

unknown

The value to check

value is Error

True if the value is an instance of Error, false otherwise

SandboxError.isError


static prepareStackTrace(err, stackTraces): any

Error

CallSite[]

any

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

SandboxError.prepareStackTrace