Skip to content

AgentsError

Base class for all errors thrown by the library.

Extends

Section titled “Extends”
  • Error

Extended by

Section titled “Extended by”

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”
new AgentsError(message, state?): AgentsError;

Parameters

Section titled “Parameters”
Parameter Type

message

string

state?

RunState<any, Agent<any, any>>

Returns

Section titled “Returns”

AgentsError

Overrides

Section titled “Overrides”
Error.constructor

Properties

Section titled “Properties”

message

Section titled “message”
message: string;

Inherited from

Section titled “Inherited from”
Error.message

name

Section titled “name”
name: string;

Inherited from

Section titled “Inherited from”
Error.name

stack?

Section titled “stack?”
optional stack: string;

Inherited from

Section titled “Inherited from”
Error.stack

state?

Section titled “state?”
optional state: RunState<any, Agent<any, any>>;

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”
Error.stackTraceLimit

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

targetObject

object

constructorOpt?

Function

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”
Error.captureStackTrace

prepareStackTrace()

Section titled “prepareStackTrace()”
static prepareStackTrace(err, stackTraces): any;

Parameters

Section titled “Parameters”
Parameter Type

err

Error

stackTraces

CallSite[]

Returns

Section titled “Returns”

any

See

Section titled “See”

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

Inherited from

Section titled “Inherited from”
Error.prepareStackTrace