Class RateLimitError

Thrown when you exceed the allowed rate limit for a route

Hierarchy (view full)

HTTPRequestError
- RateLimitError

Index

Constructors

Properties

body message name stack? statusCode type prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new RateLimitError(body, msg?): RateLimitError
Parameters
- body: APIBody
- msg: string = 'You have exceeded the allowed rate limit for this route.'
Returns RateLimitError
Overrides HTTPRequestError.constructor
- Defined in src/classes/errors.ts:257

Properties

body

message

message: string

name

name: string

`Optional`stack

stack?: string

statusCode

statusCode: number

type

type: ErrorType = ErrorType.HTTP_REQUEST_ERROR

`Static` `Optional`prepareStackTrace

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

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Methods

`Static`captureStackTrace

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