AgentError

Defined in: packages/agent/src/errors.ts:68

An error that happens in the Agent. This is the root of all errors and should be used everywhere in the Agent code (this package).

To know if the error is certified, use the isCertified getter.

Extends

• Error

Constructors

Constructor

new AgentError(code, kind): AgentError

Defined in: packages/agent/src/errors.ts:95

Parameters

code

ErrorCode

kind

ErrorKindEnum

Returns

AgentError

Overrides

Error.constructor

Properties

cause

readonly cause: object

Defined in: packages/agent/src/errors.ts:71

code

code: ErrorCode

kind

kind: ErrorKindEnum

Overrides

Error.cause

---

message

message: string

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

---

name

name: string = 'AgentError'

Defined in: packages/agent/src/errors.ts:69

Overrides

Error.name

---

stack?

optional stack: string

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@20.19.1/node_modules/@types/node/globals.d.ts:149

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

Accessors

code

Get Signature

get code(): ErrorCode

Defined in: packages/agent/src/errors.ts:73

Returns

ErrorCode

Set Signature

set code(code): void

Defined in: packages/agent/src/errors.ts:76

Parameters

code

ErrorCode

Returns

void

---

isCertified

Get Signature

get isCertified(): boolean

Defined in: packages/agent/src/errors.ts:91

Reads the isCertified property of the underlying error code.

Returns

boolean

true if the error is certified, false otherwise.

---

kind

Get Signature

get kind(): ErrorKindEnum

Defined in: packages/agent/src/errors.ts:80

Returns

ErrorKindEnum

Set Signature

set kind(kind): void

Defined in: packages/agent/src/errors.ts:83

Parameters

kind

ErrorKindEnum

Returns

void

Methods

hasCode()

hasCode<C>(code): boolean

Defined in: packages/agent/src/errors.ts:101

Type Parameters

C

C extends ErrorCode

Parameters

code

(…args) => C

Returns

boolean

---

toString()

toString(): string

Defined in: packages/agent/src/errors.ts:105

Returns a string representation of an object.

Returns

string

---

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@20.19.1/node_modules/@types/node/globals.d.ts:133

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: node_modules/.pnpm/@types+node@20.19.1/node_modules/@types/node/globals.d.ts:137

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace