ApprovalStopError

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/core/shell/approvalStop.ts:301

Base class for the two run-ending approvals outcomes, so a caller that wants to present them as an ending rather than a crash can catch both with one instanceof.

A surface that can frame should render parts (see approvalStopRows); one that cannot shows message, which is already neutralised and is already the whole explanation.

Extends

Error

Extended by

Constructors

Constructor

protected new ApprovalStopError(parts, command): ApprovalStopError

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/core/shell/approvalStop.ts:312

Parameters

parts

readonly ApprovalStopPart[]

command

string

Returns

ApprovalStopError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: websites/gauntsloth-docs-site/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

command

readonly command: string

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/core/shell/approvalStop.ts:307

What ended the run, exactly as the agent proposed it: the command for a shell subject, and the registered tool name for a gated tool or MCP call. The field name predates the gate widening past the shell; subjectParts is what decides the word the MESSAGE calls it.

message

message: string

Defined in: websites/gauntsloth-docs-site/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

name

name: string

Defined in: websites/gauntsloth-docs-site/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

parts

readonly parts: readonly ApprovalStopPart[]

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/core/shell/approvalStop.ts:310

The message’s pieces, tagged with who wrote each — see ApprovalStopPart.

stack?

optional stack?: string

Defined in: websites/gauntsloth-docs-site/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.4.0/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: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.4.0/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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace