discordeno/website/docs/generated/modules_rest.md

discordeno-monorepo / Modules / @discordeno/rest

Module: @discordeno/rest

Table of contents

Classes

• Queue

Interfaces

• CreateRequestBodyOptions
• CreateRestManagerOptions
• CreateWebhook
• InvalidRequestBucket
• InvalidRequestBucketOptions
• QueueOptions
• RequestBody
• RestManager
• RestRateLimitedPath
• RestRequestRejection
• RestRequestResponse
• RestRoutes
• SendRequestOptions
• WebhookMessageEditor

Type Aliases

• ApiVersions
• RequestMethods

Functions

• createInvalidRequestBucket
• createRestManager

Type Aliases

ApiVersions

Ƭ ApiVersions: 9 | 10

Defined in

packages/rest/src/types.ts:2439

---

RequestMethods

Ƭ RequestMethods: "GET" | "POST" | "DELETE" | "PATCH" | "PUT"

Defined in

packages/rest/src/types.ts:2438

Functions

createInvalidRequestBucket

▸ createInvalidRequestBucket(options): InvalidRequestBucket

A invalid request bucket is used in a similar manner as a leaky bucket but a invalid request bucket can be refilled as needed. It's purpose is to make sure the bot does not hit the limit to getting a 1 hr ban.

Parameters

Name	Type	Description
options	InvalidRequestBucketOptions	The options used to configure this bucket.

Returns

InvalidRequestBucket

RefillingBucket

Defined in

packages/rest/src/invalidBucket.ts:10

---

createRestManager

▸ createRestManager(options): RestManager

Parameters

Name	Type
options	CreateRestManagerOptions

Returns

RestManager

Defined in

packages/rest/src/manager.ts:72