Skip to content

hywrapper-ts / Exports / RateLimitException

Class: RateLimitException

Thrown when the API rate limit has been exceeded.

Hierarchy

↳ RateLimitException

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new RateLimitException(message, isGlobal?, retryAfter?): RateLimitException

Parameters

Name Type Default value
message string undefined
isGlobal boolean false
retryAfter? number undefined

Returns

RateLimitException

Overrides

HypixelException.constructor

Defined in

src/types.ts:39

Properties

code

• Optional Readonly code: number

The HTTP status code associated with the error, if available.

Inherited from

HypixelException.code

Defined in

src/types.ts:15

isGlobal

• Readonly isGlobal: boolean = false

Whether the rate limit was triggered by the global throttle.

Defined in

src/types.ts:41

message

• message: string

Inherited from

HypixelException.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077

name

• name: string

Inherited from

HypixelException.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076

retryAfter

• Optional Readonly retryAfter: number

The number of seconds to wait before retrying

Defined in

src/types.ts:42

stack

• Optional stack: string

Inherited from

HypixelException.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078

stackTraceLimit

▪ Static stackTraceLimit: number

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

HypixelException.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

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

Name Type
targetObject object
constructorOpt? Function

Returns

void

Inherited from

HypixelException.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace

▸ prepareStackTrace(err, stackTraces): any

Parameters

Name Type
err Error
stackTraces CallSite[]

Returns

any

See

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

Inherited from

HypixelException.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56