InputGuardrailTripwireTriggered
Error thrown when an input guardrail tripwire is triggered.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new InputGuardrailTripwireTriggered( message, result, state?): InputGuardrailTripwireTriggered;
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
|
|
|
|
|
|
Returns
Section titled “Returns”InputGuardrailTripwireTriggered
Overrides
Section titled “Overrides”Properties
Section titled “Properties”message
Section titled “message”message: string;
Inherited from
Section titled “Inherited from”name: string;
Inherited from
Section titled “Inherited from”result
Section titled “result”result: InputGuardrailResult;
stack?
Section titled “stack?”optional stack: string;
Inherited from
Section titled “Inherited from”state?
Section titled “state?”optional state: RunState<any, Agent<any, any>>;
Inherited from
Section titled “Inherited from”stackTraceLimit
Section titled “stackTraceLimit”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.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”captureStackTrace()
Section titled “captureStackTrace()”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();
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
|
|
|
|
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”prepareStackTrace()
Section titled “prepareStackTrace()”static prepareStackTrace(err, stackTraces): any;
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
|
|
|
|
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces