Class BucketQueueManager

Hierarchy

BucketQueueManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new BucketQueueManager(manager: RequestManager, id: string, majorId: string): BucketQueueManager

- Defined in src/rest/BucketQueueManager.ts:17
Parameters
- manager: RequestManager
- id: string
- majorId: string
Returns BucketQueueManager

Properties

Readonly id

id: string

limit

limit: number = Infinity

The total amount of requests that can be made on this bucket before getting rate limited.

Readonly majorId

majorId: string

remaining

remaining: number = 1

The remaining requests we can make until we are rate limited.

reset

reset: number = -1

The UNIX timestamp at which this bucket's rate limit will expire.

Accessors

durUntilReset

get durUntilReset(): number

- Defined in src/rest/BucketQueueManager.ts:32
Returns number

limited

get limited(): boolean

- Defined in src/rest/BucketQueueManager.ts:46
Returns boolean

localLimited

get localLimited(): boolean

- Defined in src/rest/BucketQueueManager.ts:49
Returns boolean

Methods

handleRateLimit

handleRateLimit(req: APIRequest<any>, res: ResponseData): Promise<ResponseData>

- Defined in src/rest/BucketQueueManager.ts:35
Parameters
- req: APIRequest<any>
- res: ResponseData
Returns Promise<ResponseData>

queue

queue(req: APIRequest<any>): Promise<ResponseData>

- Defined in src/rest/BucketQueueManager.ts:53
Parameters
- req: APIRequest<any>
Returns Promise<ResponseData>

Generated using TypeDoc