AxAIServiceError

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/util/apicall.ts#L90

Extends

Error

Extended by

Constructors

Constructor

TypeScript

new AxAIServiceError(
   message: string, 
   url: string, 
   requestBody: unknown, 
   responseBody: unknown, 
   context: Record<string, unknown>, 
   includeRequestBodyInErrors: boolean): AxAIServiceError;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/util/apicall.ts#L96

Parameters

Parameter	Type	Default value
`message`	`string`	`undefined`
`url`	`string`	`undefined`
`requestBody`	`unknown`	`undefined`
`responseBody`	`unknown`	`undefined`
`context`	`Record`<`string`, `unknown`>	`{}`
`includeRequestBodyInErrors`	`boolean`	`true`

Returns

AxAIServiceError

Overrides

TypeScript

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
`cause?`	`public`	`unknown`	-	`Error.cause`
`context`	`readonly`	`Record`<`string`, `unknown`>	-	-
`errorId`	`readonly`	`string`	-	-
`includeRequestBodyInErrors`	`readonly`	`boolean`	-	-
`message`	`public`	`string`	-	`Error.message`
`name`	`public`	`string`	-	`Error.name`
`requestBody`	`readonly`	`unknown`	-	-
`responseBody`	`readonly`	`unknown`	-	-
`stack?`	`public`	`string`	-	`Error.stack`
`timestamp`	`readonly`	`string`	-	-
`url`	`readonly`	`string`	-	-
`stackTraceLimit`	`static`	`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.	`Error.stackTraceLimit`

Methods

toString()

TypeScript

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/util/apicall.ts#L114

Returns a string representation of an object.

Returns

string

captureStackTrace()

TypeScript

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

JavaScript

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:

JavaScript

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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

TypeScript

Error.captureStackTrace

prepareStackTrace()

TypeScript

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

See

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

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

TypeScript

Error.prepareStackTrace