@agentskit/core — Classes
API classes for @agentskit/core.
#Class: AdapterError
Defined in: packages/core/src/errors.ts:59
#Extends
#Constructors
#Constructor
new AdapterError(
options):AdapterError
Defined in: packages/core/src/errors.ts:60
#Parameters
options
cause?
unknown
code
string
docsUrl?
string
hint?
string
message
string
#Returns
AdapterError
#Overrides
#Properties
#cause
readonlycause:unknown
Defined in: packages/core/src/errors.ts:33
#Inherited from
#code
readonlycode:string
Defined in: packages/core/src/errors.ts:30
#Inherited from
#docsUrl
readonlydocsUrl:string|undefined
Defined in: packages/core/src/errors.ts:32
#Inherited from
#hint
readonlyhint:string|undefined
Defined in: packages/core/src/errors.ts:31
#Inherited from
#message
message:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
#Inherited from
#name
name:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
#Inherited from
#stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
#Inherited from
#stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@25.9.5/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
#Class: AgentsKitError
Defined in: packages/core/src/errors.ts:29
#Extends
Error
#Extended by
#Constructors
#Constructor
new AgentsKitError(
options):AgentsKitError
Defined in: packages/core/src/errors.ts:35
#Parameters
options
cause?
unknown
code
string
docsUrl?
string
hint?
string
message
string
#Returns
AgentsKitError
#Overrides
Error.constructor
#Properties
#cause
readonlycause:unknown
Defined in: packages/core/src/errors.ts:33
#code
readonlycode:string
Defined in: packages/core/src/errors.ts:30
#docsUrl
readonlydocsUrl:string|undefined
Defined in: packages/core/src/errors.ts:32
#hint
readonlyhint:string|undefined
Defined in: packages/core/src/errors.ts:31
#message
message:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
#Inherited from
Error.message
#name
name:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
#Inherited from
Error.name
#stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
#Inherited from
Error.stack
#stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@25.9.5/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
Error.stackTraceLimit
#Methods
#captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@25.9.5/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
Error.captureStackTrace
#prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@25.9.5/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
Error.prepareStackTrace
#toString()
toString():
string
Defined in: packages/core/src/errors.ts:50
Returns a string representation of an object.
#Returns
string
#Class: ConfigError
Defined in: packages/core/src/errors.ts:98
#Extends
#Constructors
#Constructor
new ConfigError(
options):ConfigError
Defined in: packages/core/src/errors.ts:99
#Parameters
options
cause?
unknown
code
string
docsUrl?
string
hint?
string
message
string
#Returns
ConfigError
#Overrides
#Properties
#cause
readonlycause:unknown
Defined in: packages/core/src/errors.ts:33
#Inherited from
#code
readonlycode:string
Defined in: packages/core/src/errors.ts:30
#Inherited from
#docsUrl
readonlydocsUrl:string|undefined
Defined in: packages/core/src/errors.ts:32
#Inherited from
#hint
readonlyhint:string|undefined
Defined in: packages/core/src/errors.ts:31
#Inherited from
#message
message:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
#Inherited from
#name
name:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
#Inherited from
#stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
#Inherited from
#stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@25.9.5/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
#Class: MemoryError
Defined in: packages/core/src/errors.ts:85
#Extends
#Constructors
#Constructor
new MemoryError(
options):MemoryError
Defined in: packages/core/src/errors.ts:86
#Parameters
options
cause?
unknown
code
string
docsUrl?
string
hint?
string
message
string
#Returns
MemoryError
#Overrides
#Properties
#cause
readonlycause:unknown
Defined in: packages/core/src/errors.ts:33
#Inherited from
#code
readonlycode:string
Defined in: packages/core/src/errors.ts:30
#Inherited from
#docsUrl
readonlydocsUrl:string|undefined
Defined in: packages/core/src/errors.ts:32
#Inherited from
#hint
readonlyhint:string|undefined
Defined in: packages/core/src/errors.ts:31
#Inherited from
#message
message:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
#Inherited from
#name
name:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
#Inherited from
#stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
#Inherited from
#stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@25.9.5/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
#Class: RuntimeError
Defined in: packages/core/src/errors.ts:111
#Extends
#Constructors
#Constructor
new RuntimeError(
options):RuntimeError
Defined in: packages/core/src/errors.ts:112
#Parameters
options
cause?
unknown
code
string
docsUrl?
string
hint?
string
message
string
#Returns
RuntimeError
#Overrides
#Properties
#cause
readonlycause:unknown
Defined in: packages/core/src/errors.ts:33
#Inherited from
#code
readonlycode:string
Defined in: packages/core/src/errors.ts:30
#Inherited from
#docsUrl
readonlydocsUrl:string|undefined
Defined in: packages/core/src/errors.ts:32
#Inherited from
#hint
readonlyhint:string|undefined
Defined in: packages/core/src/errors.ts:31
#Inherited from
#message
message:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
#Inherited from
#name
name:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
#Inherited from
#stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
#Inherited from
#stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@25.9.5/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
#Class: SandboxError
Defined in: packages/core/src/errors.ts:124
#Extends
#Constructors
#Constructor
new SandboxError(
options):SandboxError
Defined in: packages/core/src/errors.ts:125
#Parameters
options
cause?
unknown
code
string
docsUrl?
string
hint?
string
message
string
#Returns
SandboxError
#Overrides
#Properties
#cause
readonlycause:unknown
Defined in: packages/core/src/errors.ts:33
#Inherited from
#code
readonlycode:string
Defined in: packages/core/src/errors.ts:30
#Inherited from
#docsUrl
readonlydocsUrl:string|undefined
Defined in: packages/core/src/errors.ts:32
#Inherited from
#hint
readonlyhint:string|undefined
Defined in: packages/core/src/errors.ts:31
#Inherited from
#message
message:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
#Inherited from
#name
name:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
#Inherited from
#stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
#Inherited from
#stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@25.9.5/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
#Class: SkillError
Defined in: packages/core/src/errors.ts:137
#Extends
#Constructors
#Constructor
new SkillError(
options):SkillError
Defined in: packages/core/src/errors.ts:138
#Parameters
options
cause?
unknown
code
string
docsUrl?
string
hint?
string
message
string
#Returns
SkillError
#Overrides
#Properties
#cause
readonlycause:unknown
Defined in: packages/core/src/errors.ts:33
#Inherited from
#code
readonlycode:string
Defined in: packages/core/src/errors.ts:30
#Inherited from
#docsUrl
readonlydocsUrl:string|undefined
Defined in: packages/core/src/errors.ts:32
#Inherited from
#hint
readonlyhint:string|undefined
Defined in: packages/core/src/errors.ts:31
#Inherited from
#message
message:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
#Inherited from
#name
name:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
#Inherited from
#stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
#Inherited from
#stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@25.9.5/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
#Class: ToolError
Defined in: packages/core/src/errors.ts:72
#Extends
#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
#Properties
#cause
readonlycause:unknown
Defined in: packages/core/src/errors.ts:33
#Inherited from
#code
readonlycode:string
Defined in: packages/core/src/errors.ts:30
#Inherited from
#docsUrl
readonlydocsUrl:string|undefined
Defined in: packages/core/src/errors.ts:32
#Inherited from
#hint
readonlyhint:string|undefined
Defined in: packages/core/src/errors.ts:31
#Inherited from
#message
message:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
#Inherited from
#name
name:
string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
#Inherited from
#stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
#Inherited from
#stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@25.9.5/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()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@25.9.5/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