AxAIRefusalError Generated TypeScript API reference. typescript api api/reference build/apidocs/Class.AxAIRefusalError.md class AxAIRefusalError

AxAIRefusalError

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

Extends

  • Error

Constructors

Constructor

TypeScript
new AxAIRefusalError(
   refusalMessage: string, 
   model?: string, 
   requestId?: string, 
   category?: null | string, 
   explanation?: null | string): AxAIRefusalError;

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

Parameters

ParameterType
refusalMessagestring
model?string
requestId?string
category?null | string
explanation?null | string

Returns

AxAIRefusalError

Overrides

TypeScript
Error.constructor

Properties

PropertyModifierTypeDescriptionInherited from
category?readonlynull | string--
cause?publicunknown-Error.cause
errorIdreadonlystring--
explanation?readonlynull | string--
messagepublicstring-Error.message
model?readonlystring--
namepublicstring-Error.name
refusalMessagereadonlystring--
requestId?readonlystring--
stack?publicstring-Error.stack
timestampreadonlystring--
stackTraceLimitstaticnumberThe 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#L341

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

ParameterType
targetObjectobject
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

ParameterType
errError
stackTracesCallSite[]

Returns

any

Inherited from

TypeScript
Error.prepareStackTrace
Docs