Class DiscordRESTError

A REST error received from Discord.

Hierarchy

Error
- DiscordRESTError

Index

Constructors

Properties

cause? code message method name resBody response stack? prepareStackTrace? stackTraceLimit

Accessors

headers path status statusText

Methods

toJSON captureStackTrace flattenErrors

Constructors

constructor

new DiscordRESTError(res: Response, resBody: Record<string, unknown>, method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH", stack?: string): DiscordRESTError
Parameters
- res: Response
- resBody: Record<string, unknown>
- method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"
- Optional stack: string
Returns DiscordRESTError
Overrides Error.constructor
- Defined in lib/rest/DiscordRESTError.ts:13

Properties

`Optional` cause

cause?: unknown

code

code: number

message

message: string

method

method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"

name

name: string = "DiscordRESTError"

resBody

resBody: null | Record<string, unknown>

response

response: Response

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Accessors

headers

get headers(): Headers
Returns Headers
- Defined in lib/rest/DiscordRESTError.ts:66

path

get path(): string
Returns string
- Defined in lib/rest/DiscordRESTError.ts:69

status

get status(): number
Returns number
- Defined in lib/rest/DiscordRESTError.ts:72

statusText

get statusText(): string
Returns string
- Defined in lib/rest/DiscordRESTError.ts:75

Methods

toJSON

toJSON(): JSONDiscordRESTError
Returns JSONDiscordRESTError
- Defined in lib/rest/DiscordRESTError.ts:79

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

`Static` flattenErrors

flattenErrors(errors: Record<string, unknown>, keyPrefix?: string): string[]
Parameters
- errors: Record<string, unknown>
- keyPrefix: string = ""
Returns string[]
- Defined in lib/rest/DiscordRESTError.ts:49