Skip to content

Class: FusionClientError

Defined in: packages/core/src/client/FusionClient.ts:105

Structured error parsed from a <tool_error> XML envelope.

Provides typed access to self-healing fields so client code can programmatically react to server errors without regex parsing.

Extends

  • Error

Constructors

Constructor

ts
new FusionClientError(
   message, 
   code, 
   raw, 
   options?): FusionClientError;

Defined in: packages/core/src/client/FusionClient.ts:117

Parameters

ParameterType
messagestring
codestring
rawToolResponse
options?{ availableActions?: string[]; recovery?: string; severity?: string; }
options.availableActions?string[]
options.recovery?string
options.severity?string

Returns

FusionClientError

Overrides

ts
Error.constructor

Properties

availableActions

ts
readonly availableActions: readonly string[];

Defined in: packages/core/src/client/FusionClient.ts:111

Available actions from <available_actions> children.


cause?

ts
optional cause: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

ts
Error.cause

code

ts
readonly code: string;

Defined in: packages/core/src/client/FusionClient.ts:107

Error code from the code attribute (e.g. 'NOT_FOUND').


message

ts
message: string;

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

Inherited from

ts
Error.message

name

ts
name: string;

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

Inherited from

ts
Error.name

raw

ts
readonly raw: ToolResponse;

Defined in: packages/core/src/client/FusionClient.ts:115

Raw ToolResponse that caused the error.


recovery?

ts
readonly optional recovery: string;

Defined in: packages/core/src/client/FusionClient.ts:109

Recovery suggestion from <recovery> element.


severity

ts
readonly severity: string;

Defined in: packages/core/src/client/FusionClient.ts:113

Error severity from the severity attribute.


stack?

ts
optional stack: string;

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

Inherited from

ts
Error.stack

stackTraceLimit

ts
static stackTraceLimit: number;

Defined in: 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

ts
Error.stackTraceLimit

Methods

captureStackTrace()

ts
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: 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.

js
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:

js
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

ParameterType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

ts
Error.captureStackTrace

prepareStackTrace()

ts
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

ParameterType
errError
stackTracesCallSite[]

Returns

any

See

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

Inherited from

ts
Error.prepareStackTrace