Class RestBucketInternal

constructor

• new RestBucket(
      id: `${string}(${string})`,
      bucketHash: string,
      majorParameter: string,
      manager: Rest,
  ): RestBucket

  Create a rest bucket.

  Parameters

  • id: `${string}(${string})`

    The bucket's ID.
  • bucketHash: string

    The bucket's unique RestBucketHash hash.
  • majorParameter: string

    The RestMajorParameter major parameter associated with the bucket.
  • manager: Rest

    The rest manager the bucket is bound to.

  Returns RestBucket

allowedRequestsPerRatelimit

ReadonlybucketHash

Readonlyid

ReadonlymajorParameter

manager

requestsLeft

resetAt

Readonlysystem

Static ReadonlyRATELIMIT_HEADERS

active

• get active(): boolean

  If the bucket is currently making a request.

  Returns boolean

ratelimited

• get ratelimited(): { any: boolean; global: boolean; local: boolean }

  Get information on the bucket's current rate limit restrictions.

  Returns { any: boolean; global: boolean; local: boolean }

request

• request(
      method: RestMethod,
      route: `/${string}`,
      routeHash:
          | `GET;${string}`
          | `POST;${string}`
          | `PUT;${string}`
          | `DELETE;${string}`
          | `PATCH;${string}`,
      options: RestRequestData,
  ): Promise<RestMakeResponse>

  Make a rest request with this bucket's rate limits.

  Parameters

  • method: RestMethod

    The request's method.
  • route: `/${string}`

    The requests's route, relative to the base Discord API URL. (Example: /channels/123456789000000000)
  • routeHash:
        | `GET;${string}`
        | `POST;${string}`
        | `PUT;${string}`
        | `DELETE;${string}`
        | `PATCH;${string}`

    The request's route hash.
  • options: RestRequestData

    Request options.

  Returns Promise<RestMakeResponse>

  Response data.