Skip to main content

Class: GuardrailStopError

Defined in: packages/agentos/src/api/errors.ts:44

A call that carried guards was stopped: by a rule (GUARDRAIL_BLOCKED), for a person's review (GUARDRAIL_HELD), or because a guard that runs closed could not judge (GUARDRAIL_UNAVAILABLE). Its message is one fixed sentence; it never holds a guard's reason, the prompt or the reply.

Extends​

  • Error

Constructors​

Constructor​

new GuardrailStopError(init): GuardrailStopError

Defined in: packages/agentos/src/api/errors.ts:57

Parameters​

init​
code​

"GUARDRAIL_BLOCKED" | "GUARDRAIL_HELD" | "GUARDRAIL_UNAVAILABLE"

guardrailId?​

string

hold?​

GuardrailHold

reasonCode?​

string

report​

TextGuardrailReport

stage​

"output" | "input"

usage?​

TokenUsage

Returns​

GuardrailStopError

Overrides​

Error.constructor

Properties​

code​

readonly code: "GUARDRAIL_BLOCKED" | "GUARDRAIL_HELD" | "GUARDRAIL_UNAVAILABLE"

Defined in: packages/agentos/src/api/errors.ts:46


guardrailId?​

readonly optional guardrailId: string

Defined in: packages/agentos/src/api/errors.ts:50


hold?​

readonly optional hold: GuardrailHold

Defined in: packages/agentos/src/api/errors.ts:51


message​

message: string

Defined in: apps/agentos-live-docs/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

Error.message


name​

readonly name: "GuardrailStopError" = 'GuardrailStopError'

Defined in: packages/agentos/src/api/errors.ts:45

Overrides​

Error.name


reasonCode?​

readonly optional reasonCode: string

Defined in: packages/agentos/src/api/errors.ts:49


report​

readonly report: TextGuardrailReport

Defined in: packages/agentos/src/api/errors.ts:53

What each stage's guards answered, as codes and ids.


stack?​

optional stack: string

Defined in: apps/agentos-live-docs/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

Error.stack


stage​

readonly stage: "output" | "input"

Defined in: packages/agentos/src/api/errors.ts:48

Where the call stopped: before the first provider request, or before the reply reached the caller.


usage?​

readonly optional usage: TokenUsage

Defined in: packages/agentos/src/api/errors.ts:55

What the call had spent when it stopped; set on the output stage.


stackTraceLimit​

static stackTraceLimit: number

Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/globals.d.ts:68

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: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/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​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

Error.captureStackTrace


prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/globals.d.ts:56

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace