Class RateLimitBucket

Hierarchy

RateLimitBucket

Index

Constructors

constructor

Properties

remaining

Methods

send

Constructors

constructor

new RateLimitBucket(bot: Bot, token: string, route: EndpointRoute, method: HttpMethod): RateLimitBucket

- Defined in src/api/rateLimit/RateLimitBucket.ts:57
Parameters
- bot: Bot
- token: string
- route: EndpointRoute
- method: HttpMethod
Returns RateLimitBucket

Properties

remaining

remaining: number | undefined

The number of remaining requests this bucket has until the next reset {@link reset}

Methods

send

send<T>(endpoint: string, params: Params, files?: RequestFile[]): Promise<T>

- Defined in src/api/rateLimit/RateLimitBucket.ts:82
Creates a new API request and sends it if the bucket is capable of doing so

Type parameters
- T
Parameters
- endpoint: string
  
  The request endpoint
- params: Params
  
  The request params / body
- Optional files: RequestFile[]
  
  The files sent in this request
Returns Promise<T>

Generated using TypeDoc