Class: ToolError

Defined in: packages/core/src/errors.ts:72

#Extends

• AgentsKitError

#Constructors

#Constructor

new ToolError(options): ToolError

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

#Parameters

options

cause?

unknown

code

string

docsUrl?

string

hint?

string

message

string

#Returns

ToolError

#Overrides

AgentsKitError.constructor

#Properties

#cause

readonly cause: unknown

Defined in: packages/core/src/errors.ts:33

#Inherited from

AgentsKitError.cause

#code

readonly code: string

Defined in: packages/core/src/errors.ts:30

#Inherited from

AgentsKitError.code

#docsUrl

readonly docsUrl: string | undefined

Defined in: packages/core/src/errors.ts:32

#Inherited from

AgentsKitError.docsUrl

#hint

readonly hint: string | undefined

Defined in: packages/core/src/errors.ts:31

#Inherited from

AgentsKitError.hint

#message

message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

#Inherited from

AgentsKitError.message

#name

name: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

#Inherited from

AgentsKitError.name

#stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

#Inherited from

AgentsKitError.stack

#stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.6.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

AgentsKitError.stackTraceLimit

#Methods

#captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.6.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

AgentsKitError.captureStackTrace

#prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.6.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

AgentsKitError.prepareStackTrace

#toString()

toString(): string

Defined in: packages/core/src/errors.ts:50

Returns a string representation of an object.

#Returns

string

#Inherited from

AgentsKitError.toString