RateLimitedError

Overview

An error for a request that a server rate limit refused, with status 429.

The message ends with how long to wait when the response has a Retry-After header. Without the header, the message says to try again later. The message leaves out the status code and text, because the first sentence already says why the request failed.

Properties

cause

Type: unknown

Source: node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

message

Type: string

Source: client/lib/utils/errors.js:97

name

Type: string

Source: client/lib/utils/errors.js:96

response

The response object associated with the error.

Type: Response

Source: client/lib/utils/errors.js:67

responseData

The data returned in the response. Decoded if JSON, otherwise a string.

Type: any

Source: client/lib/utils/errors.js:72

retryAfterSeconds

The seconds the server asked the client to wait, from the Retry-After header. It is null when the response has no header in whole seconds.

Type: number

Source: client/lib/utils/errors.js:104

stack

Type: string

Source: node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078

stackTraceLimit

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.

Type: number

Source: node_modules/.pnpm/@types+node@22.19.11/node_modules/@types/node/globals.d.ts:68

Methods

• constructor - Creates an instance of RateLimitedError.
• captureStackTrace - Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
• prepareStackTrace

Source

client/lib/utils/errors.js:84