Class: RateLimitError

@kortexya/reasoninglayer

@kortexya/reasoninglayer / RateLimitError

Class: RateLimitError

Defined in: src/errors.ts:692

Rate limit error (HTTP 429).

The request was rate-limited. Carries rate limit metadata from response headers.

Extends

ApiError

Constructors

Constructor

new RateLimitError(message, body, headers, errorCode?, retryAfter?, limit?, remaining?): RateLimitError

Defined in: src/errors.ts:702

Parameters

message

string

body

unknown

headers

Headers

errorCode?

string

retryAfter?

number | null

limit?

number | null

remaining?

number | null

Returns

RateLimitError

Overrides

ApiError.constructor

Properties

body

readonly body: unknown

Defined in: src/errors.ts:55

Parsed response body.

Inherited from

ApiError.body

cause?

optional cause?: unknown

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

Inherited from

ApiError.cause

errorCode

readonly errorCode: string | undefined

Defined in: src/errors.ts:53

Backend error code (from response body error field), if present.

Inherited from

ApiError.errorCode

headers

readonly headers: Headers

Defined in: src/errors.ts:57

Response headers.

Inherited from

ApiError.headers

limit

readonly limit: number | null

Defined in: src/errors.ts:698

Maximum requests allowed in the current window, or null if not specified.

message

message: string

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

Inherited from

ApiError.message

name

name: string = 'RateLimitError'

Defined in: src/errors.ts:693

Overrides

ApiError.name

remaining

readonly remaining: number | null

Defined in: src/errors.ts:700

Requests remaining in the current window, or null if not specified.

retryAfter

readonly retryAfter: number | null

Defined in: src/errors.ts:696

Seconds to wait before retrying, or null if not specified.

stack?

optional stack?: string

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

Inherited from

ApiError.stack

status

readonly status: number

Defined in: src/errors.ts:51

HTTP status code.

Inherited from

ApiError.status

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@24.13.3/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

ApiError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@24.13.3/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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ApiError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ApiError.prepareStackTrace