Skip to content

RESTError

Defined in: packages/rest/src/errors.ts:88

Error thrown when Discord rejects a REST request.

  • Error

new RESTError(message, status, code?, errors?, options?): RESTError

Defined in: packages/rest/src/errors.ts:104

Creates a REST error with request context.

string

Error message.

number

HTTP status.

number

Discord error code.

unknown

Raw error payload.

Request context and cause.

unknown

RESTErrorKind

string

string

RESTError

Error.constructor

optional cause?: unknown

Defined in: lunibee.js.org/node_modules/typescript/lib/lib.es2022.error.d.ts:24

The cause of the error.

Error.cause


readonly optional code?: number

Defined in: packages/rest/src/errors.ts:94

Discord API error code, when provided.


readonly optional errors?: unknown

Defined in: packages/rest/src/errors.ts:96

Raw Discord validation/error payload.


readonly optional hint?: string

Defined in: packages/rest/src/errors.ts:102

What to check next, for errors with a common cause (missing access or permissions).


readonly kind: RESTErrorKind

Defined in: packages/rest/src/errors.ts:90

Failure category.


message: string

Defined in: lunibee.js.org/node_modules/typescript/lib/lib.es5.d.ts:1075

Error.message


readonly optional method?: string

Defined in: packages/rest/src/errors.ts:98

HTTP method used for the failed request.


name: string

Defined in: lunibee.js.org/node_modules/typescript/lib/lib.es5.d.ts:1074

Error.name


readonly optional path?: string

Defined in: packages/rest/src/errors.ts:100

API path used for the failed request.


optional stack?: string

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

Error.stack


readonly status: number

Defined in: packages/rest/src/errors.ts:92

HTTP status returned by Discord.


static stackTraceLimit: number

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/globals.d.ts:67

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

get retryable(): boolean

Defined in: packages/rest/src/errors.ts:133

Whether sending the same request again later could succeed. Validation, permission, authentication and not-found failures never will.

boolean

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/globals.d.ts:51

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();

object

Function

void

Error.captureStackTrace

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/bun-types@1.4.2/node_modules/bun-types/globals.d.ts:1081

Create .stack property on a target object

object

Function

void

Error.captureStackTrace


static isError(error): error is Error

Defined in: lunibee.js.org/node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

unknown

error is Error

Error.isError

static isError(value): value is Error

Defined in: node_modules/.bun/bun-types@1.4.2/node_modules/bun-types/globals.d.ts:1076

Check if a value is an instance of Error

unknown

The value to check

value is Error

True if the value is an instance of Error, false otherwise

Error.isError


static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/globals.d.ts:55

Error

CallSite[]

any

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

Error.prepareStackTrace