ModelThrottledError

Defined in: src/errors.ts:121

Error thrown when a model provider returns a throttling or rate limit error.

This error indicates that the model API has rate limited the request. Users can handle this error in hooks to implement custom retry strategies using the AfterModelCallEvent.retry mechanism.

Extends

• ModelError

Constructors

Constructor

new ModelThrottledError(message, options?): ModelThrottledError;

Defined in: src/errors.ts:128

Creates a new ModelThrottledError.

Parameters

Parameter	Type	Description
message	string	Error message describing the throttling condition
options?	ErrorOptions	Optional error options including cause for error chaining

Returns

ModelThrottledError

Overrides

ModelError.constructor

Properties

stackTraceLimit

static stackTraceLimit: number;

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

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

ModelError.stackTraceLimit

---

cause?

optional cause: unknown;

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

Inherited from

ModelError.cause

---

name

name: string;

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

Inherited from

ModelError.name

---

message

message: string;

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

Inherited from

ModelError.message

---

stack?

optional stack: string;

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

Inherited from

ModelError.stack

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

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

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

ModelError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

ModelError.prepareStackTrace