Class RatelimitError

Hierarchy

Error
- RatelimitError

Index

Constructors

Properties

cause? message name remaining stack? status prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new RatelimitError(response: CustomResponse, data?: APIError): RatelimitError
Parameters
- response: CustomResponse
- Optional data: APIError
Returns RatelimitError
Overrides Error.constructor
- Defined in src/errors/RatelimitError.ts:18

Properties

`Optional` cause

cause?: unknown

message

message: string

The message of this error

name

name: string

The type of error (RatelimitError)

remaining

remaining: number

The time remaining for your ratelimit to expire in milliseconds

`Optional` stack

stack?: string

status

status: number

HTTP status of the error

`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

Methods

`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/.pnpm/@types+node@20.2.3/node_modules/@types/node/globals.d.ts:4

Generated using TypeDoc