RESTError
Defined in: packages/rest/src/errors.ts:88
Error thrown when Discord rejects a REST request.
Extends
Section titled “Extends”Error
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RESTError(
message,status,code?,errors?,options?):RESTError
Defined in: packages/rest/src/errors.ts:104
Creates a REST error with request context.
Parameters
Section titled “Parameters”message
Section titled “message”string
Error message.
status
Section titled “status”number
HTTP status.
number
Discord error code.
errors?
Section titled “errors?”unknown
Raw error payload.
options?
Section titled “options?”Request context and cause.
cause?
Section titled “cause?”unknown
method?
Section titled “method?”string
string
Returns
Section titled “Returns”RESTError
Overrides
Section titled “Overrides”Error.constructor
Properties
Section titled “Properties”cause?
Section titled “cause?”
optionalcause?:unknown
Defined in: lunibee.js.org/node_modules/typescript/lib/lib.es2022.error.d.ts:24
The cause of the error.
Inherited from
Section titled “Inherited from”Error.cause
readonlyoptionalcode?:number
Defined in: packages/rest/src/errors.ts:94
Discord API error code, when provided.
errors?
Section titled “errors?”
readonlyoptionalerrors?:unknown
Defined in: packages/rest/src/errors.ts:96
Raw Discord validation/error payload.
readonlyoptionalhint?:string
Defined in: packages/rest/src/errors.ts:102
What to check next, for errors with a common cause (missing access or permissions).
readonlykind:RESTErrorKind
Defined in: packages/rest/src/errors.ts:90
Failure category.
message
Section titled “message”message:
string
Defined in: lunibee.js.org/node_modules/typescript/lib/lib.es5.d.ts:1075
Inherited from
Section titled “Inherited from”Error.message
method?
Section titled “method?”
readonlyoptionalmethod?: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
Inherited from
Section titled “Inherited from”Error.name
readonlyoptionalpath?:string
Defined in: packages/rest/src/errors.ts:100
API path used for the failed request.
stack?
Section titled “stack?”
optionalstack?:string
Defined in: lunibee.js.org/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”Error.stack
status
Section titled “status”
readonlystatus:number
Defined in: packages/rest/src/errors.ts:92
HTTP status returned by Discord.
stackTraceLimit
Section titled “stackTraceLimit”
staticstackTraceLimit: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.
Inherited from
Section titled “Inherited from”Error.stackTraceLimit
Accessors
Section titled “Accessors”retryable
Section titled “retryable”Get Signature
Section titled “Get Signature”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.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”captureStackTrace()
Section titled “captureStackTrace()”Call Signature
Section titled “Call Signature”
staticcaptureStackTrace(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();Parameters
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Error.captureStackTrace
Call Signature
Section titled “Call Signature”
staticcaptureStackTrace(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
Parameters
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Error.captureStackTrace
isError()
Section titled “isError()”Call Signature
Section titled “Call Signature”
staticisError(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.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”error is Error
Inherited from
Section titled “Inherited from”Error.isError
Call Signature
Section titled “Call Signature”
staticisError(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
Parameters
Section titled “Parameters”unknown
The value to check
Returns
Section titled “Returns”value is Error
True if the value is an instance of Error, false otherwise
Inherited from
Section titled “Inherited from”Error.isError
prepareStackTrace()
Section titled “prepareStackTrace()”
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/globals.d.ts:55
Parameters
Section titled “Parameters”Error
stackTraces
Section titled “stackTraces”CallSite[]
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Section titled “Inherited from”Error.prepareStackTrace