diff --git a/packages/rest/src/manager.ts b/packages/rest/src/manager.ts index 2247a0f3e..41dbeddc5 100644 --- a/packages/rest/src/manager.ts +++ b/packages/rest/src/manager.ts @@ -879,7 +879,6 @@ export function createRestManager(options: CreateRestManagerOptions): RestManage rest.invalidBucket.handleCompletedRequest(response.status, response.headers.get('X-RateLimit-Scope') === 'shared') const resetAfter = response.headers.get('x-ratelimit-reset-after') - logger.warn(`Request to ${url} was rate limited. Reset after ${resetAfter} seconds.`) if (resetAfter) await delay(Number(resetAfter) * 1000) // process the response to prevent mem leak await response.json() diff --git a/packages/rest/src/queue.ts b/packages/rest/src/queue.ts index 535deb0c9..5d3983288 100644 --- a/packages/rest/src/queue.ts +++ b/packages/rest/src/queue.ts @@ -158,6 +158,7 @@ export class Queue { } } + /** Checks if a request is available and adds it to the queue. Also triggers queue processing if not already processing. */ async makeRequest(options: SendRequestOptions): Promise { await this.waitUntilRequestAvailable() this.pending.push(options) diff --git a/packages/rest/tests/e2e/guild.spec.ts b/packages/rest/tests/e2e/guild.spec.ts index 0002cc424..1ecd9de4d 100644 --- a/packages/rest/tests/e2e/guild.spec.ts +++ b/packages/rest/tests/e2e/guild.spec.ts @@ -10,18 +10,13 @@ describe('Guild helpers', async () => { // Delete the oldest guild(most likely to have finished tests). it('Create and delete a guild', async () => { - logger.info('Create and delete a guild') const guild = await rest.createGuild({ name: 'Discordeno-test', }) - logger.info('Guild created', guild.id) expect(guild.id).to.be.exist - logger.info('Guild exists', guild.id) await rest.deleteGuild(guild.id) - logger.info('Guild deleted', guild.id) // Make sure the guild was deleted await expect(rest.getGuild(guild.id)).to.eventually.rejected - logger.info('Guild deleted confirmed', guild.id) }) describe('Edit and get', async () => { diff --git a/scripts/finalizeTypedocs.js b/scripts/finalizeTypedocs.js index bc4ceaa89..e808e5248 100644 --- a/scripts/finalizeTypedocs.js +++ b/scripts/finalizeTypedocs.js @@ -16,8 +16,6 @@ async function* walk(dir) { for await (let filepath of walk(typedocOutPath)) { if (filepath.endsWith('.json')) continue - // if (filepath.includes('/generated/classes')) console.log('file in classes', filepath) - // if (filepath.includes('/generated/modules')) console.log('file in modules', filepath) let file = fs.readFileSync(filepath, 'utf-8') if (filepath.endsWith('generated/README.md')) { @@ -28,8 +26,6 @@ for await (let filepath of walk(typedocOutPath)) { '', 'Thank you for using Discordeno. These docs are generated automatically. If you see any issues please contact us on [Discord](https://discord.gg/ddeno)', ].join('\n') - // console.log('renaming readme', filepath) - // filepath = filepath.replace("README", "Docs") } // Removes the old file in case it had ugly name, will be recreated below diff --git a/website/docs/bigbot/step-2-rest.md b/website/docs/bigbot/step-2-rest.md index c0817b56d..d96a0cce8 100644 --- a/website/docs/bigbot/step-2-rest.md +++ b/website/docs/bigbot/step-2-rest.md @@ -11,3 +11,185 @@ Awesome, if you have reached this far you know that this guide will be using the Remember if you need any help with an alternative to the above listed items, please contact us on Discord. +## Creating Your REST Manager + +Now we can finally get started. Make a file anywhere you like for example `services/rest/rest.ts`. Note that you can make it anywhere and call it whatever you want. For the purposes of this guide, we will make it as if they are microservices. + +Once you have the file, copy paste this code in there. + +```ts +import { createRestManager } from '@discordeno/rest' + +export const REST = createRestManager({ + // YOUR BOT TOKEN HERE + token: process.env.TOKEN, +}) +``` + +:::tip +If you haven't already, install the @discordeno/rest package. Need help? Check the Installation page in the guides. +::: + +This code we have created will maintain a manager that will handle all the outgoing requests to discord. What we need to do now, is create a listener that will handle all the incoming requests from all of our services and forward them to this manager. + +## Creating A HTTP Listener + +Now you can make another file like `services/rest/index.ts`. Then paste the code below: + +```ts +import dotenv from 'dotenv' +import express from 'express' +dotenv.config() + +import { REST } from './rest.ts' + +const REST_AUTHORIZATION = process.env.REST_AUTHORIZATION as string + +const app = express() + +app.use( + express.urlencoded({ + extended: true, + }), +) + +app.use(express.json()) + +app.all('/*', async (req, res) => { + if (!REST_AUTHORIZATION || REST_AUTHORIZATION !== req.headers.authorization) { + return res.status(401).json({ error: 'Invalid authorization key.' }) + } + + try { + const result = await REST.makeRequest(req.method, `${REST.baseUrl}${req.url}`, req.body) + + if (result) { + res.status(200).json(result) + } else { + res.status(204).json() + } + } catch (error: any) { + console.log(error) + res.status(500).json(error) + } +}) + +app.listen(REST_PORT, () => { + console.log(`REST listening at ${REST_URL}`) +}) +``` + +Now let's take a minute to explain this part very briefly. The majority of this code is about creating a http listener in Node.JS to listen for requests coming into this process. When any request comes in it first checks if the authorization header matches. This is a small security challenge, to help prevent unknown users from making requests with your token should they find the url your hosting this listener on. This guide, uses `dotenv` package to handle private secrets but you can use anything you like. + +:::tip +Take the time to go back to the rest.ts file we made earlier and adjust the `token` property to use dotenv as well, should you want to optimize your code. +::: + +If a request was not authorized, it will be ignored. If a request comes with a proper authorization header, we will proceed to making the request. This request is forwarded to our REST we made earlier in rest.ts file. We add on the discord base url to the route and forward it. The manager will handle all rate limits and queues and anything else to make the request. When it responds, it will either return a valid response or an error. This successful response or error is than handled as needed and sent back to original process that called this listener. + +## Setting Up Analytics + +Because we are making a bot in millions of discord server, we are going to want some nice analytics into our REST manager. So let's take a minute to setup some analytics. We are going to use InfluxDB but you can use anything you like. + +Make another file `services/rest/analytics.ts` and paste the code below. + +```ts +import { InfluxDB, Point } from '@influxdata/influxdb-client' +import { REST } from './rest.ts' + +const INFLUX_ORG = process.env.INFLUX_ORG as string +const INFLUX_BUCKET = process.env.INFLUX_BUCKET as string +const INFLUX_TOKEN = process.env.INFLUX_TOKEN as string +const INFLUX_URL = process.env.INFLUX_URL as string + +export const influxDB = INFLUX_URL && INFLUX_TOKEN ? new InfluxDB({ url: INFLUX_URL, token: INFLUX_TOKEN }) : undefined +export const Influx = influxDB?.getWriteApi(INFLUX_ORG, INFLUX_BUCKET) + +let savingAnalyticsId: NodeJS.Interval | undefined = undefined +if (!saveAnalyticsId) { + setInterval(() => { + console.log(`[Influx - REST] Saving events...`) + Influx?.flush() + .then(() => { + console.log(`[Influx - REST] Saved events!`) + }) + .catch((error) => { + console.log(`[Influx - REST] Error saving events!`, error) + }) + // Every 30seconds + }, 30000) +} +``` + +Now let's go back to our http listener in `services/rest/index.ts` and implement the analytics. Let's add in the Influx portion by first importing it. + +```ts +import { Influx } from './analytics.ts' +``` + +Now, make sure to scroll to this line as we are going to work around this line now. + +```ts +const result = await REST.makeRequest(req.method, `${REST.baseUrl}${req.url}`, req.body) +``` + +```ts +Influx?.writePoint( + new Point('restEvents') + .timestamp(new Date()) + .stringField('type', 'REQUEST_FETCHING') + .tag('method', options.method) + .tag('url', options.url) + .tag('bucket', options.bucketId ?? 'NA'), +) +const result = await REST.makeRequest(req.method, `${REST.baseUrl}${req.url}`, req.body) +``` + +This will add to the analytics whenever a request comes in. Then we should add another one for when a request is successful. + +```ts +Influx?.writePoint( + new Point('restEvents') + .timestamp(new Date()) + .stringField('type', 'REQUEST_FETCHING') + .tag('method', options.method) + .tag('url', options.url) + .tag('bucket', options.bucketId ?? 'NA'), +) +const result = await REST.makeRequest(req.method, `${REST.baseUrl}${req.url}`, req.body) +Influx?.writePoint( + new Point('restEvents') + .timestamp(new Date()) + .stringField('type', 'REQUEST_FETCHED') + .tag('method', options.method) + .tag('url', options.url) + .tag('bucket', options.bucketId ?? 'NA') + .intField('status', response.status) + .tag('statusText', response.statusText), +); +``` + +Finally, we should now move to the `catch` portion in this file, to add analytics for whenever a request fails. + +```ts +catch (error: any) { + Influx?.writePoint( + new Point('restEvents') + .timestamp(new Date()) + .stringField('type', 'REQUEST_FAILED') + .tag('method', options.method) + .tag('url', options.url) + .tag('bucket', options.bucketId ?? 'NA') + .intField('status', error.status ?? 399) + .tag('statusText', error.statusText ?? "Unknown"), + ); + console.log(error); + res.status(500).json(error); +} +``` + +### Grafana + +Now you will be able to take this data and implement it into Grafana. In a future time, if possible, we will add more detailed guide on how to setup grafana. But for now, you can follow this guide: + +[Grafana + Influx](https://grafana.com/docs/grafana/latest/getting-started/get-started-grafana-influxdb/) diff --git a/website/docs/generated/README.md b/website/docs/generated/README.md index c265002e0..13d5f74eb 100644 --- a/website/docs/generated/README.md +++ b/website/docs/generated/README.md @@ -2,110 +2,4 @@ discordeno-monorepo / [Modules](modules.md) # Discordeno - - -Discord API library for [Node.JS](https://nodejs.org), [Deno](https://deno.land) & [Bun](https://bun.sh/) - -[![Discord](https://img.shields.io/discord/785384884197392384?color=7289da&logo=discord&logoColor=dark)](https://discord.com/invite/5vBgXk3UcZ) -[![codecov](https://codecov.io/gh/discordeno/discordeno/branch/main/graph/badge.svg?token=SQI9OYJ7AK)](https://codecov.io/gh/discordeno/discordeno) - -## Tips - -- If you are already convinced about using Discordeno, go to [Getting Started](https://discordeno.mod.land) -- To learn if Discordeno is right for you, read everything below. - -## Packages - -| Package | npm | Tests | Coverage | -| ------------------------------------------------------------------------ | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [discordeno](https://www.npmjs.com/package/discordeno) | ![npm (scoped)](https://img.shields.io/npm/v/discordeno) | ![action status](https://github.com/discordeno/discordeno/actions/workflows/discordeno-test.yml/badge.svg?event=push) | [![codecov](https://codecov.io/gh/discordeno/discordeno/branch/main/graph/badge.svg?token=SQI9OYJ7AK&flag=discordeno)](https://codecov.io/gh/discordeno/discordeno) | -| [@discordeno/types](https://www.npmjs.com/package/@discordeno/types) | ![npm (scoped)](https://img.shields.io/npm/v/@discordeno/types) | ![action status](https://github.com/discordeno/discordeno/actions/workflows/types-test.yml/badge.svg?event=push) | [![codecov](https://codecov.io/gh/discordeno/discordeno/branch/main/graph/badge.svg?token=SQI9OYJ7AK&flag=types)](https://codecov.io/gh/discordeno/discordeno) | -| [@discordeno/utils](https://www.npmjs.com/package/@discordeno/utils) | ![npm (scoped)](https://img.shields.io/npm/v/@discordeno/utils) | ![action status](https://github.com/discordeno/discordeno/actions/workflows/utils-test.yml/badge.svg?event=push) | [![codecov](https://codecov.io/gh/discordeno/discordeno/branch/main/graph/badge.svg?token=SQI9OYJ7AK&flag=utils)](https://codecov.io/gh/discordeno/discordeno) | -| [@discordeno/rest](https://www.npmjs.com/package/@discordeno/rest) | ![npm (scoped)](https://img.shields.io/npm/v/@discordeno/rest) | ![action status](https://github.com/discordeno/discordeno/actions/workflows/rest-test.yml/badge.svg?event=push) | [![codecov](https://codecov.io/gh/discordeno/discordeno/branch/main/graph/badge.svg?token=SQI9OYJ7AK&flag=rest)](https://codecov.io/gh/discordeno/discordeno) | -| [@discordeno/gateway](https://www.npmjs.com/package/@discordeno/gateway) | ![npm (scoped)](https://img.shields.io/npm/v/@discordeno/gateway) | ![action status](https://github.com/discordeno/discordeno/actions/workflows/gateway-test.yml/badge.svg?event=push) | [![codecov](https://codecov.io/gh/discordeno/discordeno/branch/main/graph/badge.svg?token=SQI9OYJ7AK&flag=gateway)](https://codecov.io/gh/discordeno/discordeno) | -| [@discordeno/bot](https://www.npmjs.com/package/@discordeno/bot) | ![npm (scoped)](https://img.shields.io/npm/v/@discordeno/bot) | ![action status](https://github.com/discordeno/discordeno/actions/workflows/bot-test.yml/badge.svg?event=push) | [![codecov](https://codecov.io/gh/discordeno/discordeno/branch/main/graph/badge.svg?token=SQI9OYJ7AK&flag=bot)](https://codecov.io/gh/discordeno/discordeno) | - -## Features - -Discordeno is actively maintained to guarantee **excellent performance, latest features, and ease of use.** - -- **Simple, Efficient, and Lightweight**: Discordeno is lightweight, simple to use, and adaptable. - - By default: No caching. -- **Functional & Class API**: Discordeno is flexible enough to provide both methods. - - The functional API eliminates the challenges of extending built-in classes and inheritance while ensuring overall simple but performant code. - - The class based API, client package, provides a similar api as the [Eris](https://github.com/abalabahaha/eris) library to provide the best class based experience. -- **Cross Runtime**: Supports the Node.js, Deno, and Bun runtimes. -- **Standalone components**: Discordeno offers the option to have practically any component of a bot as a separate - piece, including standalone REST, gateways, custom caches, and more. -- **Flexibility/Scalability:** Remove any properties, if your bot doesn't need them. For instance, remove `Channel.topic` if your bot doesn't require it. You may save GBs of RAM in this way. A few lines of code are all that are needed to accomplish this for any property on any object. - -### REST - -- Freedom from 1 hour downtimes due to invalid requests - - Prevent your bot from being down for an hour, by lowering the maximum downtime to 10 minutes. -- Freedom from global rate limit errors - - As a bot grows, you need to handle global rate limits better. Shards don't communicate fast enough to truly - handle it properly. With one point of contact to discords API, you will never have issues again. - - Numerous instances of your bot on different hosts, all of which can connect to the same REST server. -- REST does not rest! - - Separate rest guarantees that your queued requests will continue to be processed even if your bot breaks for - whatever reason. - - Seamless updates! When updating/restarting a bot, you'll lose a lot of messages or replies that are queued/processing. -- Single point of contact to Discord API - - Send requests from any location, even a bot dashboard directly. - - Don't send requests from dashboard to bot process to send a request to discord. Your bot process should - be freed up to handle bot events! -- Scalability! Scalability! Scalability! - -### Gateway - -- **Zero Downtime Updates:** - - Others: With non-proxy bots, it takes about 5s per shard bucket to start up. With 100,000 servers, this would be minimum of 8+ minutes of downtime for bot updates. - - Discordeno Proxy Gateway: Resume the bot code almost instantly without worrying about any delays or wasting your identify limits. -- **Zero Downtime Resharding:** - - Discord stops allowing your bot to be added to new servers when you max out your existing max shards. Consider a bot started with 150 shards - operating on 150,000 servers. Your shards support a maximum of 150 \* 2500 = 375,000 servers. Your - bot will be unable to join new servers once it reaches this point until it re-shards. - - DD proxy provides 2 types of re-sharding. Automated and manual. You can also have both. - - Automated: This system will automatically begin a Zero-downtime resharding process behind the scenes when you - reach 80% of your maximum servers allowed by your shards. For example, since 375,000 was the max, at 300,000 we - would begin re-sharding behind the scenes with ZERO DOWNTIME. - - 80% of maximum servers reached (The % of 80% is customizable.) - - Identify limits have room to allow re-sharding. (Also customizable) - - Manual: You can also trigger this manually should you choose. - - When discord releases a new API version, updates your gateways to new version with no downtime. -- **Horizontal Scaling:** - - When your bot grows a lot, you have - two options: you can either keep investing money to upgrade your server or you may expand horizontally by purchasing - several more affordable servers. The proxy enables WS handling on multiple servers. -- **No Loss Restarts:** - - Without the proxy mechanism, you would typically lose a lot of events while restarting. Users could issue - instructions or send messages that are not automoderated. As your bot grows, this amount grows sharply. - Users who don't receive the automatic roles or any other activities your bot should do. - - While your bot is unavailable, events can be added to a queue, and once the bot is back online, the queue will start processing all of the events. -- **Flexibility:** - - You have complete control over everything inside the gateway thanks to the controller aspect. Need to customize, the way the manager talks to the workers? Simply, plug in and override the method. -- **Clustering With Workers:** - - Utilize all of your CPU cores to their greatest potential by distributing the workload across workers. To enhance - efficiency, manage how shards per worker. - -### Custom Cache - -Have your cache setup in any way you like. Redis, PGSQL or any cache layer you would like. - -## Getting Started - -Interested? [Check the website](https://discordeno.mod.land) for more details on getting started. - -### Tools - -This library is not intended for beginners, however if you still want to utilise it, check out these excellent official -and unofficial templates: - -## Links - -- [Website](https://discordeno.mod.land) -- [Documentation](https://doc.deno.land/https/deno.land/x/discordeno/mod.ts) -- [Discord](https://discord.com/invite/5vBgXk3UcZ) - -Discordeno follows [semantic versioning](https://semver.org/) +Thank you for using Discordeno. These docs are generated automatically. If you see any issues please contact us on [Discord](https://discord.gg/ddeno) \ No newline at end of file diff --git a/website/docs/generated/modules.md b/website/docs/generated/modules.md index 28c163e67..b7b165351 100644 --- a/website/docs/generated/modules.md +++ b/website/docs/generated/modules.md @@ -6,9 +6,9 @@ ### Modules -- [@discordeno/bot](modules/discordeno_bot.md) -- [@discordeno/client](modules/discordeno_client.md) -- [@discordeno/gateway](modules/discordeno_gateway.md) -- [@discordeno/rest](modules/discordeno_rest.md) -- [@discordeno/types](modules/discordeno_types.md) -- [@discordeno/utils](modules/discordeno_utils.md) +- [@discordeno/bot](modules/md) +- [@discordeno/client](modules/md) +- [@discordeno/gateway](modules/md) +- [@discordeno/rest](modules/md) +- [@discordeno/types](modules/md) +- [@discordeno/utils](modules/md) diff --git a/website/docs/generated/modules_bot.md b/website/docs/generated/modules_bot.md deleted file mode 100644 index 464ce0813..000000000 --- a/website/docs/generated/modules_bot.md +++ /dev/null @@ -1,2719 +0,0 @@ -[discordeno-monorepo](../README.md) / [Modules](../modules.md) / @discordeno/bot - -# Module: @discordeno/bot - -## Table of contents - -### Enumerations - -- [ActivityTypes](../enums/ActivityTypes.md) -- [AllowedMentionsTypes](../enums/AllowedMentionsTypes.md) -- [ApplicationCommandOptionTypes](../enums/ApplicationCommandOptionTypes.md) -- [ApplicationCommandPermissionTypes](../enums/ApplicationCommandPermissionTypes.md) -- [ApplicationCommandTypes](../enums/ApplicationCommandTypes.md) -- [ApplicationFlags](../enums/ApplicationFlags.md) -- [AuditLogEvents](../enums/AuditLogEvents.md) -- [AutoModerationActionType](../enums/AutoModerationActionType.md) -- [AutoModerationEventTypes](../enums/AutoModerationEventTypes.md) -- [AutoModerationTriggerTypes](../enums/AutoModerationTriggerTypes.md) -- [BitwisePermissionFlags](../enums/BitwisePermissionFlags.md) -- [ButtonStyles](../enums/ButtonStyles.md) -- [ChannelFlags](../enums/ChannelFlags.md) -- [ChannelTypes](../enums/ChannelTypes.md) -- [DefaultMessageNotificationLevels](../enums/DefaultMessageNotificationLevels.md) -- [DiscordAutoModerationRuleTriggerMetadataPresets](../enums/DiscordAutoModerationRuleTriggerMetadataPresets.md) -- [ExplicitContentFilterLevels](../enums/ExplicitContentFilterLevels.md) -- [GatewayCloseEventCodes](../enums/GatewayCloseEventCodes.md) -- [GatewayIntents](../enums/GatewayIntents.md) -- [GatewayOpcodes](../enums/GatewayOpcodes.md) -- [GuildFeatures](../enums/GuildFeatures.md) -- [GuildNsfwLevel](../enums/GuildNsfwLevel.md) -- [IntegrationExpireBehaviors](../enums/IntegrationExpireBehaviors.md) -- [InteractionResponseTypes](../enums/InteractionResponseTypes.md) -- [InteractionTypes](../enums/InteractionTypes.md) -- [Locales](../enums/Locales.md) -- [LogDepth](../enums/LogDepth.md) -- [LogLevels](../enums/LogLevels.md) -- [MessageActivityTypes](../enums/MessageActivityTypes.md) -- [MessageComponentTypes](../enums/MessageComponentTypes.md) -- [MessageTypes](../enums/MessageTypes.md) -- [MfaLevels](../enums/MfaLevels.md) -- [OverwriteTypes](../enums/OverwriteTypes.md) -- [PremiumTiers](../enums/PremiumTiers.md) -- [PremiumTypes](../enums/PremiumTypes.md) -- [PresenceStatus](../enums/PresenceStatus.md) -- [ScheduledEventEntityType](../enums/ScheduledEventEntityType.md) -- [ScheduledEventPrivacyLevel](../enums/ScheduledEventPrivacyLevel.md) -- [ScheduledEventStatus](../enums/ScheduledEventStatus.md) -- [ShardSocketCloseCodes](../enums/ShardSocketCloseCodes.md) -- [ShardState](../enums/ShardState.md) -- [SortOrderTypes](../enums/SortOrderTypes.md) -- [StickerFormatTypes](../enums/StickerFormatTypes.md) -- [StickerTypes](../enums/StickerTypes.md) -- [SystemChannelFlags](../enums/SystemChannelFlags.md) -- [TargetTypes](../enums/TargetTypes.md) -- [TeamMembershipStates](../enums/TeamMembershipStates.md) -- [TextStyles](../enums/TextStyles.md) -- [UserFlags](../enums/UserFlags.md) -- [VerificationLevels](../enums/VerificationLevels.md) -- [VideoQualityModes](../enums/VideoQualityModes.md) -- [WebhookTypes](../enums/WebhookTypes.md) - -### Classes - -- [Collection](../classes/Collection.md) -- [DiscordenoShard](../classes/DiscordenoShard.md) -- [Queue](../classes/Queue.md) - -### Interfaces - -- [ActionRow](../interfaces/ActionRow.md) -- [AllowedMentions](../interfaces/AllowedMentions.md) -- [ApplicationCommandOption](../interfaces/ApplicationCommandOption.md) -- [ApplicationCommandOptionChoice](../interfaces/ApplicationCommandOptionChoice.md) -- [ApplicationCommandPermissions](../interfaces/ApplicationCommandPermissions.md) -- [BeginGuildPrune](../interfaces/BeginGuildPrune.md) -- [Bot](../interfaces/Bot.md) -- [BotActivity](../interfaces/BotActivity.md) -- [BotStatusUpdate](../interfaces/BotStatusUpdate.md) -- [ButtonComponent](../interfaces/ButtonComponent.md) -- [Code](../interfaces/Code.md) -- [CollectionOptions](../interfaces/CollectionOptions.md) -- [CollectionSweeper](../interfaces/CollectionSweeper.md) -- [CreateAutoModerationRuleOptions](../interfaces/CreateAutoModerationRuleOptions.md) -- [CreateBotOptions](../interfaces/CreateBotOptions.md) -- [CreateChannelInvite](../interfaces/CreateChannelInvite.md) -- [CreateContextApplicationCommand](../interfaces/CreateContextApplicationCommand.md) -- [CreateForumPostWithMessage](../interfaces/CreateForumPostWithMessage.md) -- [CreateGatewayManagerOptions](../interfaces/CreateGatewayManagerOptions.md) -- [CreateGuild](../interfaces/CreateGuild.md) -- [CreateGuildBan](../interfaces/CreateGuildBan.md) -- [CreateGuildChannel](../interfaces/CreateGuildChannel.md) -- [CreateGuildEmoji](../interfaces/CreateGuildEmoji.md) -- [CreateGuildFromTemplate](../interfaces/CreateGuildFromTemplate.md) -- [CreateGuildRole](../interfaces/CreateGuildRole.md) -- [CreateGuildStickerOptions](../interfaces/CreateGuildStickerOptions.md) -- [CreateMessageOptions](../interfaces/CreateMessageOptions.md) -- [CreateRequestBodyOptions](../interfaces/CreateRequestBodyOptions.md) -- [CreateRestManagerOptions](../interfaces/CreateRestManagerOptions.md) -- [CreateScheduledEvent](../interfaces/CreateScheduledEvent.md) -- [CreateSlashApplicationCommand](../interfaces/CreateSlashApplicationCommand.md) -- [CreateStageInstance](../interfaces/CreateStageInstance.md) -- [CreateTemplate](../interfaces/CreateTemplate.md) -- [CreateWebhook](../interfaces/CreateWebhook.md) -- [DeleteWebhookMessageOptions](../interfaces/DeleteWebhookMessageOptions.md) -- [DiscordActionRow](../interfaces/DiscordActionRow.md) -- [DiscordActiveThreads](../interfaces/DiscordActiveThreads.md) -- [DiscordActivity](../interfaces/DiscordActivity.md) -- [DiscordActivityAssets](../interfaces/DiscordActivityAssets.md) -- [DiscordActivityButton](../interfaces/DiscordActivityButton.md) -- [DiscordActivityEmoji](../interfaces/DiscordActivityEmoji.md) -- [DiscordActivityParty](../interfaces/DiscordActivityParty.md) -- [DiscordActivitySecrets](../interfaces/DiscordActivitySecrets.md) -- [DiscordActivityTimestamps](../interfaces/DiscordActivityTimestamps.md) -- [DiscordAllowedMentions](../interfaces/DiscordAllowedMentions.md) -- [DiscordApplication](../interfaces/DiscordApplication.md) -- [DiscordApplicationCommand](../interfaces/DiscordApplicationCommand.md) -- [DiscordApplicationCommandOption](../interfaces/DiscordApplicationCommandOption.md) -- [DiscordApplicationCommandOptionChoice](../interfaces/DiscordApplicationCommandOptionChoice.md) -- [DiscordApplicationCommandPermissions](../interfaces/DiscordApplicationCommandPermissions.md) -- [DiscordApplicationWebhook](../interfaces/DiscordApplicationWebhook.md) -- [DiscordAttachment](../interfaces/DiscordAttachment.md) -- [DiscordAuditLog](../interfaces/DiscordAuditLog.md) -- [DiscordAuditLogEntry](../interfaces/DiscordAuditLogEntry.md) -- [DiscordAutoModerationAction](../interfaces/DiscordAutoModerationAction.md) -- [DiscordAutoModerationActionExecution](../interfaces/DiscordAutoModerationActionExecution.md) -- [DiscordAutoModerationActionMetadata](../interfaces/DiscordAutoModerationActionMetadata.md) -- [DiscordAutoModerationRule](../interfaces/DiscordAutoModerationRule.md) -- [DiscordAutoModerationRuleTriggerMetadata](../interfaces/DiscordAutoModerationRuleTriggerMetadata.md) -- [DiscordBan](../interfaces/DiscordBan.md) -- [DiscordButtonComponent](../interfaces/DiscordButtonComponent.md) -- [DiscordChannel](../interfaces/DiscordChannel.md) -- [DiscordChannelMention](../interfaces/DiscordChannelMention.md) -- [DiscordChannelPinsUpdate](../interfaces/DiscordChannelPinsUpdate.md) -- [DiscordClientStatus](../interfaces/DiscordClientStatus.md) -- [DiscordCreateApplicationCommand](../interfaces/DiscordCreateApplicationCommand.md) -- [DiscordCreateForumPostWithMessage](../interfaces/DiscordCreateForumPostWithMessage.md) -- [DiscordCreateGuildChannel](../interfaces/DiscordCreateGuildChannel.md) -- [DiscordCreateGuildEmoji](../interfaces/DiscordCreateGuildEmoji.md) -- [DiscordCreateMessage](../interfaces/DiscordCreateMessage.md) -- [DiscordCreateWebhook](../interfaces/DiscordCreateWebhook.md) -- [DiscordDefaultReactionEmoji](../interfaces/DiscordDefaultReactionEmoji.md) -- [DiscordEditChannelPermissionOverridesOptions](../interfaces/DiscordEditChannelPermissionOverridesOptions.md) -- [DiscordEmbed](../interfaces/DiscordEmbed.md) -- [DiscordEmbedAuthor](../interfaces/DiscordEmbedAuthor.md) -- [DiscordEmbedField](../interfaces/DiscordEmbedField.md) -- [DiscordEmbedFooter](../interfaces/DiscordEmbedFooter.md) -- [DiscordEmbedImage](../interfaces/DiscordEmbedImage.md) -- [DiscordEmbedProvider](../interfaces/DiscordEmbedProvider.md) -- [DiscordEmbedThumbnail](../interfaces/DiscordEmbedThumbnail.md) -- [DiscordEmbedVideo](../interfaces/DiscordEmbedVideo.md) -- [DiscordEmoji](../interfaces/DiscordEmoji.md) -- [DiscordFollowAnnouncementChannel](../interfaces/DiscordFollowAnnouncementChannel.md) -- [DiscordFollowedChannel](../interfaces/DiscordFollowedChannel.md) -- [DiscordForumTag](../interfaces/DiscordForumTag.md) -- [DiscordGatewayPayload](../interfaces/DiscordGatewayPayload.md) -- [DiscordGetGatewayBot](../interfaces/DiscordGetGatewayBot.md) -- [DiscordGuild](../interfaces/DiscordGuild.md) -- [DiscordGuildApplicationCommandPermissions](../interfaces/DiscordGuildApplicationCommandPermissions.md) -- [DiscordGuildBanAddRemove](../interfaces/DiscordGuildBanAddRemove.md) -- [DiscordGuildEmojisUpdate](../interfaces/DiscordGuildEmojisUpdate.md) -- [DiscordGuildIntegrationsUpdate](../interfaces/DiscordGuildIntegrationsUpdate.md) -- [DiscordGuildMemberAdd](../interfaces/DiscordGuildMemberAdd.md) -- [DiscordGuildMemberRemove](../interfaces/DiscordGuildMemberRemove.md) -- [DiscordGuildMemberUpdate](../interfaces/DiscordGuildMemberUpdate.md) -- [DiscordGuildMembersChunk](../interfaces/DiscordGuildMembersChunk.md) -- [DiscordGuildPreview](../interfaces/DiscordGuildPreview.md) -- [DiscordGuildRoleCreate](../interfaces/DiscordGuildRoleCreate.md) -- [DiscordGuildRoleDelete](../interfaces/DiscordGuildRoleDelete.md) -- [DiscordGuildRoleUpdate](../interfaces/DiscordGuildRoleUpdate.md) -- [DiscordGuildStickersUpdate](../interfaces/DiscordGuildStickersUpdate.md) -- [DiscordGuildWidget](../interfaces/DiscordGuildWidget.md) -- [DiscordGuildWidgetSettings](../interfaces/DiscordGuildWidgetSettings.md) -- [DiscordHello](../interfaces/DiscordHello.md) -- [DiscordIncomingWebhook](../interfaces/DiscordIncomingWebhook.md) -- [DiscordInputTextComponent](../interfaces/DiscordInputTextComponent.md) -- [DiscordInstallParams](../interfaces/DiscordInstallParams.md) -- [DiscordIntegration](../interfaces/DiscordIntegration.md) -- [DiscordIntegrationAccount](../interfaces/DiscordIntegrationAccount.md) -- [DiscordIntegrationApplication](../interfaces/DiscordIntegrationApplication.md) -- [DiscordIntegrationCreateUpdate](../interfaces/DiscordIntegrationCreateUpdate.md) -- [DiscordIntegrationDelete](../interfaces/DiscordIntegrationDelete.md) -- [DiscordInteraction](../interfaces/DiscordInteraction.md) -- [DiscordInteractionData](../interfaces/DiscordInteractionData.md) -- [DiscordInteractionDataOption](../interfaces/DiscordInteractionDataOption.md) -- [DiscordInteractionMember](../interfaces/DiscordInteractionMember.md) -- [DiscordInvite](../interfaces/DiscordInvite.md) -- [DiscordInviteCreate](../interfaces/DiscordInviteCreate.md) -- [DiscordInviteDelete](../interfaces/DiscordInviteDelete.md) -- [DiscordInviteMetadata](../interfaces/DiscordInviteMetadata.md) -- [DiscordInviteStageInstance](../interfaces/DiscordInviteStageInstance.md) -- [DiscordListActiveThreads](../interfaces/DiscordListActiveThreads.md) -- [DiscordListArchivedThreads](../interfaces/DiscordListArchivedThreads.md) -- [DiscordMember](../interfaces/DiscordMember.md) -- [DiscordMemberWithUser](../interfaces/DiscordMemberWithUser.md) -- [DiscordMessage](../interfaces/DiscordMessage.md) -- [DiscordMessageActivity](../interfaces/DiscordMessageActivity.md) -- [DiscordMessageDelete](../interfaces/DiscordMessageDelete.md) -- [DiscordMessageDeleteBulk](../interfaces/DiscordMessageDeleteBulk.md) -- [DiscordMessageInteraction](../interfaces/DiscordMessageInteraction.md) -- [DiscordMessageReactionAdd](../interfaces/DiscordMessageReactionAdd.md) -- [DiscordMessageReactionRemove](../interfaces/DiscordMessageReactionRemove.md) -- [DiscordMessageReactionRemoveAll](../interfaces/DiscordMessageReactionRemoveAll.md) -- [DiscordMessageReference](../interfaces/DiscordMessageReference.md) -- [DiscordModifyChannel](../interfaces/DiscordModifyChannel.md) -- [DiscordModifyGuildChannelPositions](../interfaces/DiscordModifyGuildChannelPositions.md) -- [DiscordModifyGuildEmoji](../interfaces/DiscordModifyGuildEmoji.md) -- [DiscordModifyGuildWelcomeScreen](../interfaces/DiscordModifyGuildWelcomeScreen.md) -- [DiscordOptionalAuditEntryInfo](../interfaces/DiscordOptionalAuditEntryInfo.md) -- [DiscordOverwrite](../interfaces/DiscordOverwrite.md) -- [DiscordPresenceUpdate](../interfaces/DiscordPresenceUpdate.md) -- [DiscordPrunedCount](../interfaces/DiscordPrunedCount.md) -- [DiscordReaction](../interfaces/DiscordReaction.md) -- [DiscordReady](../interfaces/DiscordReady.md) -- [DiscordRole](../interfaces/DiscordRole.md) -- [DiscordRoleTags](../interfaces/DiscordRoleTags.md) -- [DiscordScheduledEvent](../interfaces/DiscordScheduledEvent.md) -- [DiscordScheduledEventEntityMetadata](../interfaces/DiscordScheduledEventEntityMetadata.md) -- [DiscordScheduledEventUserAdd](../interfaces/DiscordScheduledEventUserAdd.md) -- [DiscordScheduledEventUserRemove](../interfaces/DiscordScheduledEventUserRemove.md) -- [DiscordSelectMenuComponent](../interfaces/DiscordSelectMenuComponent.md) -- [DiscordSelectOption](../interfaces/DiscordSelectOption.md) -- [DiscordSessionStartLimit](../interfaces/DiscordSessionStartLimit.md) -- [DiscordStageInstance](../interfaces/DiscordStageInstance.md) -- [DiscordSticker](../interfaces/DiscordSticker.md) -- [DiscordStickerItem](../interfaces/DiscordStickerItem.md) -- [DiscordStickerPack](../interfaces/DiscordStickerPack.md) -- [DiscordTeam](../interfaces/DiscordTeam.md) -- [DiscordTeamMember](../interfaces/DiscordTeamMember.md) -- [DiscordTemplate](../interfaces/DiscordTemplate.md) -- [DiscordThreadListSync](../interfaces/DiscordThreadListSync.md) -- [DiscordThreadMember](../interfaces/DiscordThreadMember.md) -- [DiscordThreadMemberUpdate](../interfaces/DiscordThreadMemberUpdate.md) -- [DiscordThreadMembersUpdate](../interfaces/DiscordThreadMembersUpdate.md) -- [DiscordThreadMetadata](../interfaces/DiscordThreadMetadata.md) -- [DiscordTypingStart](../interfaces/DiscordTypingStart.md) -- [DiscordUnavailableGuild](../interfaces/DiscordUnavailableGuild.md) -- [DiscordUser](../interfaces/DiscordUser.md) -- [DiscordVanityUrl](../interfaces/DiscordVanityUrl.md) -- [DiscordVoiceRegion](../interfaces/DiscordVoiceRegion.md) -- [DiscordVoiceServerUpdate](../interfaces/DiscordVoiceServerUpdate.md) -- [DiscordVoiceState](../interfaces/DiscordVoiceState.md) -- [DiscordWebhookUpdate](../interfaces/DiscordWebhookUpdate.md) -- [DiscordWelcomeScreen](../interfaces/DiscordWelcomeScreen.md) -- [DiscordWelcomeScreenChannel](../interfaces/DiscordWelcomeScreenChannel.md) -- [EditAutoModerationRuleOptions](../interfaces/EditAutoModerationRuleOptions.md) -- [EditBotMemberOptions](../interfaces/EditBotMemberOptions.md) -- [EditChannelPermissionOverridesOptions](../interfaces/EditChannelPermissionOverridesOptions.md) -- [EditGuildRole](../interfaces/EditGuildRole.md) -- [EditGuildStickerOptions](../interfaces/EditGuildStickerOptions.md) -- [EditMessage](../interfaces/EditMessage.md) -- [EditOwnVoiceState](../interfaces/EditOwnVoiceState.md) -- [EditScheduledEvent](../interfaces/EditScheduledEvent.md) -- [EditStageInstanceOptions](../interfaces/EditStageInstanceOptions.md) -- [EditUserVoiceState](../interfaces/EditUserVoiceState.md) -- [EventHandlers](../interfaces/EventHandlers.md) -- [ExecuteWebhook](../interfaces/ExecuteWebhook.md) -- [FileContent](../interfaces/FileContent.md) -- [GatewayManager](../interfaces/GatewayManager.md) -- [GetBans](../interfaces/GetBans.md) -- [GetGuildAuditLog](../interfaces/GetGuildAuditLog.md) -- [GetGuildPruneCountQuery](../interfaces/GetGuildPruneCountQuery.md) -- [GetGuildWidgetImageQuery](../interfaces/GetGuildWidgetImageQuery.md) -- [GetInvite](../interfaces/GetInvite.md) -- [GetMessagesAfter](../interfaces/GetMessagesAfter.md) -- [GetMessagesAround](../interfaces/GetMessagesAround.md) -- [GetMessagesBefore](../interfaces/GetMessagesBefore.md) -- [GetMessagesLimit](../interfaces/GetMessagesLimit.md) -- [GetReactions](../interfaces/GetReactions.md) -- [GetScheduledEventUsers](../interfaces/GetScheduledEventUsers.md) -- [GetScheduledEvents](../interfaces/GetScheduledEvents.md) -- [GetWebhookMessageOptions](../interfaces/GetWebhookMessageOptions.md) -- [InputTextComponent](../interfaces/InputTextComponent.md) -- [InteractionCallbackData](../interfaces/InteractionCallbackData.md) -- [InteractionResponse](../interfaces/InteractionResponse.md) -- [InvalidRequestBucket](../interfaces/InvalidRequestBucket.md) -- [InvalidRequestBucketOptions](../interfaces/InvalidRequestBucketOptions.md) -- [LeakyBucket](../interfaces/LeakyBucket.md) -- [ListArchivedThreads](../interfaces/ListArchivedThreads.md) -- [ListGuildMembers](../interfaces/ListGuildMembers.md) -- [ModifyChannel](../interfaces/ModifyChannel.md) -- [ModifyGuild](../interfaces/ModifyGuild.md) -- [ModifyGuildChannelPositions](../interfaces/ModifyGuildChannelPositions.md) -- [ModifyGuildEmoji](../interfaces/ModifyGuildEmoji.md) -- [ModifyGuildMember](../interfaces/ModifyGuildMember.md) -- [ModifyGuildTemplate](../interfaces/ModifyGuildTemplate.md) -- [ModifyRolePositions](../interfaces/ModifyRolePositions.md) -- [ModifyWebhook](../interfaces/ModifyWebhook.md) -- [OverwriteReadable](../interfaces/OverwriteReadable.md) -- [PlaceHolderBot](../interfaces/PlaceHolderBot.md) -- [QueueOptions](../interfaces/QueueOptions.md) -- [RequestBody](../interfaces/RequestBody.md) -- [RequestGuildMembers](../interfaces/RequestGuildMembers.md) -- [RequestMemberRequest](../interfaces/RequestMemberRequest.md) -- [RestManager](../interfaces/RestManager.md) -- [RestRateLimitedPath](../interfaces/RestRateLimitedPath.md) -- [RestRequestRejection](../interfaces/RestRequestRejection.md) -- [RestRequestResponse](../interfaces/RestRequestResponse.md) -- [RestRoutes](../interfaces/RestRoutes.md) -- [Rgb](../interfaces/Rgb.md) -- [SearchMembers](../interfaces/SearchMembers.md) -- [SelectMenuChannelsComponent](../interfaces/SelectMenuChannelsComponent.md) -- [SelectMenuComponent](../interfaces/SelectMenuComponent.md) -- [SelectMenuRolesComponent](../interfaces/SelectMenuRolesComponent.md) -- [SelectMenuUsersAndRolesComponent](../interfaces/SelectMenuUsersAndRolesComponent.md) -- [SelectMenuUsersComponent](../interfaces/SelectMenuUsersComponent.md) -- [SelectOption](../interfaces/SelectOption.md) -- [SendRequestOptions](../interfaces/SendRequestOptions.md) -- [ShardCreateOptions](../interfaces/ShardCreateOptions.md) -- [ShardEvents](../interfaces/ShardEvents.md) -- [ShardGatewayConfig](../interfaces/ShardGatewayConfig.md) -- [ShardHeart](../interfaces/ShardHeart.md) -- [ShardSocketRequest](../interfaces/ShardSocketRequest.md) -- [StartThreadWithMessage](../interfaces/StartThreadWithMessage.md) -- [StartThreadWithoutMessage](../interfaces/StartThreadWithoutMessage.md) -- [StatusUpdate](../interfaces/StatusUpdate.md) -- [UpdateVoiceState](../interfaces/UpdateVoiceState.md) -- [WebhookMessageEditor](../interfaces/WebhookMessageEditor.md) -- [WithReason](../interfaces/WithReason.md) - -### Type Aliases - -- [ApiVersions](md#apiversions) -- [AtLeastOne](md#atleastone) -- [BigString](md#bigstring) -- [CamelCase](md#camelcase) -- [Camelize](md#camelize) -- [CreateApplicationCommand](md#createapplicationcommand) -- [DiscordArchivedThreads](md#discordarchivedthreads) -- [DiscordAuditLogChange](md#discordauditlogchange) -- [DiscordMessageComponents](md#discordmessagecomponents) -- [DiscordMessageReactionRemoveEmoji](md#discordmessagereactionremoveemoji) -- [DiscordWebhook](md#discordwebhook) -- [EmbedTypes](md#embedtypes) -- [GatewayDispatchEventNames](md#gatewaydispatcheventnames) -- [GatewayEventNames](md#gatewayeventnames) -- [GetMessagesOptions](md#getmessagesoptions) -- [ImageFormat](md#imageformat) -- [ImageSize](md#imagesize) -- [Localization](md#localization) -- [MessageComponents](md#messagecomponents) -- [PermissionStrings](md#permissionstrings) -- [PickPartial](md#pickpartial) -- [RequestMethods](md#requestmethods) -- [SnakeCase](md#snakecase) -- [Snakelize](md#snakelize) - -### Variables - -- [Intents](md#intents) -- [logger](md#logger) - -### Functions - -- [acquire](md#acquire) -- [avatarUrl](md#avatarurl) -- [bgBlack](md#bgblack) -- [bgBlue](md#bgblue) -- [bgBrightBlack](md#bgbrightblack) -- [bgBrightBlue](md#bgbrightblue) -- [bgBrightCyan](md#bgbrightcyan) -- [bgBrightGreen](md#bgbrightgreen) -- [bgBrightMagenta](md#bgbrightmagenta) -- [bgBrightRed](md#bgbrightred) -- [bgBrightWhite](md#bgbrightwhite) -- [bgBrightYellow](md#bgbrightyellow) -- [bgCyan](md#bgcyan) -- [bgGreen](md#bggreen) -- [bgMagenta](md#bgmagenta) -- [bgRed](md#bgred) -- [bgRgb24](md#bgrgb24) -- [bgRgb8](md#bgrgb8) -- [bgWhite](md#bgwhite) -- [bgYellow](md#bgyellow) -- [black](md#black) -- [blue](md#blue) -- [bold](md#bold) -- [brightBlack](md#brightblack) -- [brightBlue](md#brightblue) -- [brightCyan](md#brightcyan) -- [brightGreen](md#brightgreen) -- [brightMagenta](md#brightmagenta) -- [brightRed](md#brightred) -- [brightWhite](md#brightwhite) -- [brightYellow](md#brightyellow) -- [calculateBits](md#calculatebits) -- [calculatePermissions](md#calculatepermissions) -- [camelToSnakeCase](md#cameltosnakecase) -- [camelize](md#camelize-1) -- [coerceToFileContent](md#coercetofilecontent) -- [createBot](md#createbot) -- [createGatewayManager](md#creategatewaymanager) -- [createInvalidRequestBucket](md#createinvalidrequestbucket) -- [createLeakyBucket](md#createleakybucket) -- [createLogger](md#createlogger) -- [createRestManager](md#createrestmanager) -- [cyan](md#cyan) -- [decode](md#decode) -- [delay](md#delay) -- [dim](md#dim) -- [emojiUrl](md#emojiurl) -- [encode](md#encode) -- [findFiles](md#findfiles) -- [formatImageUrl](md#formatimageurl) -- [getBotIdFromToken](md#getbotidfromtoken) -- [getColorEnabled](md#getcolorenabled) -- [getWidgetImageUrl](md#getwidgetimageurl) -- [gray](md#gray) -- [green](md#green) -- [guildBannerUrl](md#guildbannerurl) -- [guildIconUrl](md#guildiconurl) -- [guildSplashUrl](md#guildsplashurl) -- [hasProperty](md#hasproperty) -- [hidden](md#hidden) -- [iconBigintToHash](md#iconbiginttohash) -- [iconHashToBigInt](md#iconhashtobigint) -- [inverse](md#inverse) -- [isGetMessagesAfter](md#isgetmessagesafter) -- [isGetMessagesAround](md#isgetmessagesaround) -- [isGetMessagesBefore](md#isgetmessagesbefore) -- [isGetMessagesLimit](md#isgetmessageslimit) -- [italic](md#italic) -- [magenta](md#magenta) -- [nextRefill](md#nextrefill) -- [processReactionString](md#processreactionstring) -- [red](md#red) -- [removeTokenPrefix](md#removetokenprefix) -- [reset](md#reset) -- [rgb24](md#rgb24) -- [rgb8](md#rgb8) -- [setColorEnabled](md#setcolorenabled) -- [snakeToCamelCase](md#snaketocamelcase) -- [snakelize](md#snakelize-1) -- [strikethrough](md#strikethrough) -- [stripColor](md#stripcolor) -- [underline](md#underline) -- [updateTokens](md#updatetokens) -- [urlToBase64](md#urltobase64) -- [white](md#white) -- [yellow](md#yellow) - -## Type Aliases - -### ApiVersions - -Ƭ **ApiVersions**: ``9`` \| ``10`` - -#### Defined in - -packages/rest/dist/types.d.ts:2325 - -___ - -### AtLeastOne - -Ƭ **AtLeastOne**<`T`, `U`\>: `Partial`<`T`\> & `U`[keyof `U`] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `U` | { [K in keyof T]: Pick } | - -#### Defined in - -packages/types/dist/shared.d.ts:831 - -___ - -### BigString - -Ƭ **BigString**: `bigint` \| `string` - -#### Defined in - -packages/types/dist/shared.d.ts:1 - -___ - -### CamelCase - -Ƭ **CamelCase**<`S`\>: `S` extends \`${infer T}\_${infer U}\` ? \`${T}${Capitalize\>}\` : `S` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `string` | - -#### Defined in - -packages/types/dist/shared.d.ts:834 - -___ - -### Camelize - -Ƭ **Camelize**<`T`\>: `T` extends `any`[] ? `T` extends `Record`<`any`, `any`\>[] ? [`Camelize`](md#camelize)<`T`[`number`]\>[] : `T` : `T` extends `Record`<`any`, `any`\> ? { [K in keyof T as CamelCase]: Camelize } : `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/types/dist/shared.d.ts:836 - -___ - -### CreateApplicationCommand - -Ƭ **CreateApplicationCommand**: [`CreateSlashApplicationCommand`](../interfaces/CreateSlashApplicationCommand.md) \| [`CreateContextApplicationCommand`](../interfaces/CreateContextApplicationCommand.md) - -#### Defined in - -packages/types/dist/discordeno.d.ts:309 - -___ - -### DiscordArchivedThreads - -Ƭ **DiscordArchivedThreads**: [`DiscordActiveThreads`](../interfaces/DiscordActiveThreads.md) & { `hasMore`: `boolean` } - -#### Defined in - -packages/types/dist/discord.d.ts:2297 - -___ - -### DiscordAuditLogChange - -Ƭ **DiscordAuditLogChange**: { `key`: ``"name"`` \| ``"description"`` \| ``"discovery_splash_hash"`` \| ``"banner_hash"`` \| ``"preferred_locale"`` \| ``"rules_channel_id"`` \| ``"public_updates_channel_id"`` \| ``"icon_hash"`` \| ``"image_hash"`` \| ``"splash_hash"`` \| ``"owner_id"`` \| ``"region"`` \| ``"afk_channel_id"`` \| ``"vanity_url_code"`` \| ``"widget_channel_id"`` \| ``"system_channel_id"`` \| ``"topic"`` \| ``"application_id"`` \| ``"permissions"`` \| ``"allow"`` \| ``"deny"`` \| ``"code"`` \| ``"channel_id"`` \| ``"inviter_id"`` \| ``"nick"`` \| ``"avatar_hash"`` \| ``"id"`` \| ``"location"`` \| ``"command_id"`` ; `new_value`: `string` ; `old_value`: `string` } \| { `key`: ``"afk_timeout"`` \| ``"mfa_level"`` \| ``"verification_level"`` \| ``"explicit_content_filter"`` \| ``"default_message_notifications"`` \| ``"prune_delete_days"`` \| ``"position"`` \| ``"bitrate"`` \| ``"rate_limit_per_user"`` \| ``"color"`` \| ``"max_uses"`` \| ``"uses"`` \| ``"max_age"`` \| ``"expire_behavior"`` \| ``"expire_grace_period"`` \| ``"user_limit"`` \| ``"privacy_level"`` \| ``"auto_archive_duration"`` \| ``"default_auto_archive_duration"`` \| ``"entity_type"`` \| ``"status"`` \| ``"communication_disabled_until"`` ; `new_value`: `number` ; `old_value`: `number` } \| { `key`: ``"$add"`` \| ``"$remove"`` ; `new_value`: `Partial`<[`DiscordRole`](../interfaces/DiscordRole.md)\>[] ; `old_value?`: `Partial`<[`DiscordRole`](../interfaces/DiscordRole.md)\>[] } \| { `key`: ``"widget_enabled"`` \| ``"nsfw"`` \| ``"hoist"`` \| ``"mentionable"`` \| ``"temporary"`` \| ``"deaf"`` \| ``"mute"`` \| ``"enable_emoticons"`` \| ``"archived"`` \| ``"locked"`` \| ``"invitable"`` ; `new_value`: `boolean` ; `old_value`: `boolean` } \| { `key`: ``"permission_overwrites"`` ; `new_value`: [`DiscordOverwrite`](../interfaces/DiscordOverwrite.md)[] ; `old_value`: [`DiscordOverwrite`](../interfaces/DiscordOverwrite.md)[] } \| { `key`: ``"type"`` ; `new_value`: `string` \| `number` ; `old_value`: `string` \| `number` } - -https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure - -#### Defined in - -packages/types/dist/discord.d.ts:1368 - -___ - -### DiscordMessageComponents - -Ƭ **DiscordMessageComponents**: [`DiscordActionRow`](../interfaces/DiscordActionRow.md)[] - -#### Defined in - -packages/types/dist/discord.d.ts:1014 - -___ - -### DiscordMessageReactionRemoveEmoji - -Ƭ **DiscordMessageReactionRemoveEmoji**: `Pick`<[`DiscordMessageReactionAdd`](../interfaces/DiscordMessageReactionAdd.md), ``"channel_id"`` \| ``"guild_id"`` \| ``"message_id"`` \| ``"emoji"``\> - -https://discord.com/developers/docs/topics/gateway#message-reaction-remove-emoji - -#### Defined in - -packages/types/dist/discord.d.ts:2000 - -___ - -### DiscordWebhook - -Ƭ **DiscordWebhook**: [`DiscordIncomingWebhook`](../interfaces/DiscordIncomingWebhook.md) \| [`DiscordApplicationWebhook`](../interfaces/DiscordApplicationWebhook.md) - -https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-structure - -#### Defined in - -packages/types/dist/discord.d.ts:356 - -___ - -### EmbedTypes - -Ƭ **EmbedTypes**: ``"rich"`` \| ``"image"`` \| ``"video"`` \| ``"gifv"`` \| ``"article"`` \| ``"link"`` - -https://discord.com/developers/docs/resources/channel#embed-object-embed-types - -#### Defined in - -packages/types/dist/shared.d.ts:129 - -___ - -### GatewayDispatchEventNames - -Ƭ **GatewayDispatchEventNames**: ``"READY"`` \| ``"APPLICATION_COMMAND_PERMISSIONS_UPDATE"`` \| ``"AUTO_MODERATION_RULE_CREATE"`` \| ``"AUTO_MODERATION_RULE_UPDATE"`` \| ``"AUTO_MODERATION_RULE_DELETE"`` \| ``"AUTO_MODERATION_ACTION_EXECUTION"`` \| ``"CHANNEL_CREATE"`` \| ``"CHANNEL_UPDATE"`` \| ``"CHANNEL_DELETE"`` \| ``"CHANNEL_PINS_UPDATE"`` \| ``"THREAD_CREATE"`` \| ``"THREAD_UPDATE"`` \| ``"THREAD_DELETE"`` \| ``"THREAD_LIST_SYNC"`` \| ``"THREAD_MEMBER_UPDATE"`` \| ``"THREAD_MEMBERS_UPDATE"`` \| ``"GUILD_CREATE"`` \| ``"GUILD_UPDATE"`` \| ``"GUILD_DELETE"`` \| ``"GUILD_BAN_ADD"`` \| ``"GUILD_BAN_REMOVE"`` \| ``"GUILD_EMOJIS_UPDATE"`` \| ``"GUILD_STICKERS_UPDATE"`` \| ``"GUILD_INTEGRATIONS_UPDATE"`` \| ``"GUILD_MEMBER_ADD"`` \| ``"GUILD_MEMBER_REMOVE"`` \| ``"GUILD_MEMBER_UPDATE"`` \| ``"GUILD_MEMBERS_CHUNK"`` \| ``"GUILD_ROLE_CREATE"`` \| ``"GUILD_ROLE_UPDATE"`` \| ``"GUILD_ROLE_DELETE"`` \| ``"GUILD_SCHEDULED_EVENT_CREATE"`` \| ``"GUILD_SCHEDULED_EVENT_UPDATE"`` \| ``"GUILD_SCHEDULED_EVENT_DELETE"`` \| ``"GUILD_SCHEDULED_EVENT_USER_ADD"`` \| ``"GUILD_SCHEDULED_EVENT_USER_REMOVE"`` \| ``"INTEGRATION_CREATE"`` \| ``"INTEGRATION_UPDATE"`` \| ``"INTEGRATION_DELETE"`` \| ``"INTERACTION_CREATE"`` \| ``"INVITE_CREATE"`` \| ``"INVITE_DELETE"`` \| ``"MESSAGE_CREATE"`` \| ``"MESSAGE_UPDATE"`` \| ``"MESSAGE_DELETE"`` \| ``"MESSAGE_DELETE_BULK"`` \| ``"MESSAGE_REACTION_ADD"`` \| ``"MESSAGE_REACTION_REMOVE"`` \| ``"MESSAGE_REACTION_REMOVE_ALL"`` \| ``"MESSAGE_REACTION_REMOVE_EMOJI"`` \| ``"PRESENCE_UPDATE"`` \| ``"STAGE_INSTANCE_CREATE"`` \| ``"STAGE_INSTANCE_UPDATE"`` \| ``"STAGE_INSTANCE_DELETE"`` \| ``"TYPING_START"`` \| ``"USER_UPDATE"`` \| ``"VOICE_STATE_UPDATE"`` \| ``"VOICE_SERVER_UPDATE"`` \| ``"WEBHOOKS_UPDATE"`` - -#### Defined in - -packages/types/dist/shared.d.ts:643 - -___ - -### GatewayEventNames - -Ƭ **GatewayEventNames**: [`GatewayDispatchEventNames`](md#gatewaydispatcheventnames) \| ``"READY"`` \| ``"RESUMED"`` - -#### Defined in - -packages/types/dist/shared.d.ts:644 - -___ - -### GetMessagesOptions - -Ƭ **GetMessagesOptions**: [`GetMessagesAfter`](../interfaces/GetMessagesAfter.md) \| [`GetMessagesBefore`](../interfaces/GetMessagesBefore.md) \| [`GetMessagesAround`](../interfaces/GetMessagesAround.md) \| [`GetMessagesLimit`](../interfaces/GetMessagesLimit.md) - -#### Defined in - -packages/types/dist/discordeno.d.ts:242 - -___ - -### ImageFormat - -Ƭ **ImageFormat**: ``"jpg"`` \| ``"jpeg"`` \| ``"png"`` \| ``"webp"`` \| ``"gif"`` \| ``"json"`` - -https://discord.com/developers/docs/reference#image-formatting -json is only for stickers - -#### Defined in - -packages/types/dist/shared.d.ts:795 - -___ - -### ImageSize - -Ƭ **ImageSize**: ``16`` \| ``32`` \| ``64`` \| ``128`` \| ``256`` \| ``512`` \| ``1024`` \| ``2048`` \| ``4096`` - -https://discord.com/developers/docs/reference#image-formatting - -#### Defined in - -packages/types/dist/shared.d.ts:797 - -___ - -### Localization - -Ƭ **Localization**: `Partial`<`Record`<[`Locales`](../enums/Locales.md), `string`\>\> - -#### Defined in - -packages/types/dist/shared.d.ts:830 - -___ - -### MessageComponents - -Ƭ **MessageComponents**: [`ActionRow`](../interfaces/ActionRow.md)[] - -#### Defined in - -packages/types/dist/discordeno.d.ts:35 - -___ - -### PermissionStrings - -Ƭ **PermissionStrings**: keyof typeof [`BitwisePermissionFlags`](../enums/BitwisePermissionFlags.md) - -#### Defined in - -packages/types/dist/shared.d.ts:584 - -___ - -### PickPartial - -Ƭ **PickPartial**<`T`, `K`\>: { [P in keyof T]?: T[P] } & { [P in K]: T[P] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `T` | - -#### Defined in - -packages/types/dist/shared.d.ts:842 - -___ - -### RequestMethods - -Ƭ **RequestMethods**: ``"GET"`` \| ``"POST"`` \| ``"DELETE"`` \| ``"PATCH"`` \| ``"PUT"`` - -#### Defined in - -packages/rest/dist/types.d.ts:2324 - -___ - -### SnakeCase - -Ƭ **SnakeCase**<`S`\>: `S` extends \`${infer T}${infer U}\` ? \`${T extends Capitalize ? "\_" : ""}${Lowercase}${SnakeCase}\` : `S` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `string` | - -#### Defined in - -packages/types/dist/shared.d.ts:835 - -___ - -### Snakelize - -Ƭ **Snakelize**<`T`\>: `T` extends `any`[] ? `T` extends `Record`<`any`, `any`\>[] ? [`Snakelize`](md#snakelize)<`T`[`number`]\>[] : `T` : `T` extends `Record`<`any`, `any`\> ? { [K in keyof T as SnakeCase]: Snakelize } : `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/types/dist/shared.d.ts:839 - -## Variables - -### Intents - -• `Const` **Intents**: typeof [`GatewayIntents`](../enums/GatewayIntents.md) - -https://discord.com/developers/docs/topics/gateway#list-of-intents - -#### Defined in - -packages/types/dist/shared.d.ts:767 - -___ - -### logger - -• `Const` **logger**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `debug` | (...`args`: `any`[]) => `void` | -| `error` | (...`args`: `any`[]) => `void` | -| `fatal` | (...`args`: `any`[]) => `void` | -| `info` | (...`args`: `any`[]) => `void` | -| `log` | (`level`: [`LogLevels`](../enums/LogLevels.md), ...`args`: `any`[]) => `void` | -| `setDepth` | (`level`: [`LogDepth`](../enums/LogDepth.md)) => `void` | -| `setLevel` | (`level`: [`LogLevels`](../enums/LogLevels.md)) => `void` | -| `warn` | (...`args`: `any`[]) => `void` | - -#### Defined in - -packages/utils/dist/logger.d.ts:25 - -## Functions - -### acquire - -▸ **acquire**(`bucket`, `amount`, `highPriority?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bucket` | [`LeakyBucket`](../interfaces/LeakyBucket.md) | -| `amount` | `number` | -| `highPriority?` | `boolean` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/utils/dist/bucket.d.ts:54 - -___ - -### avatarUrl - -▸ **avatarUrl**(`userId`, `discriminator`, `options?`): `string` - -Builds a URL to a user's avatar stored in the Discord CDN. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userId` | [`BigString`](md#bigstring) | The ID of the user to get the avatar of. | -| `discriminator` | `string` | The user's discriminator. (4-digit tag after the hashtag.) | -| `options?` | `Object` | The parameters for the building of the URL. | -| `options.avatar` | `undefined` \| [`BigString`](md#bigstring) | - | -| `options.format?` | [`ImageFormat`](md#imageformat) | - | -| `options.size?` | [`ImageSize`](md#imagesize) | - | - -#### Returns - -`string` - -The link to the resource. - -#### Defined in - -packages/utils/dist/images.d.ts:20 - -___ - -### bgBlack - -▸ **bgBlack**(`str`): `string` - -Set background color to black. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background black | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:148 - -___ - -### bgBlue - -▸ **bgBlue**(`str`): `string` - -Set background color to blue. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background blue | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:168 - -___ - -### bgBrightBlack - -▸ **bgBrightBlack**(`str`): `string` - -Set background color to bright black. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-black | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:188 - -___ - -### bgBrightBlue - -▸ **bgBrightBlue**(`str`): `string` - -Set background color to bright blue. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-blue | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:208 - -___ - -### bgBrightCyan - -▸ **bgBrightCyan**(`str`): `string` - -Set background color to bright cyan. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-cyan | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:218 - -___ - -### bgBrightGreen - -▸ **bgBrightGreen**(`str`): `string` - -Set background color to bright green. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-green | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:198 - -___ - -### bgBrightMagenta - -▸ **bgBrightMagenta**(`str`): `string` - -Set background color to bright magenta. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-magenta | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:213 - -___ - -### bgBrightRed - -▸ **bgBrightRed**(`str`): `string` - -Set background color to bright red. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-red | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:193 - -___ - -### bgBrightWhite - -▸ **bgBrightWhite**(`str`): `string` - -Set background color to bright white. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-white | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:223 - -___ - -### bgBrightYellow - -▸ **bgBrightYellow**(`str`): `string` - -Set background color to bright yellow. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-yellow | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:203 - -___ - -### bgCyan - -▸ **bgCyan**(`str`): `string` - -Set background color to cyan. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background cyan | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:178 - -___ - -### bgGreen - -▸ **bgGreen**(`str`): `string` - -Set background color to green. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background green | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:158 - -___ - -### bgMagenta - -▸ **bgMagenta**(`str`): `string` - -Set background color to magenta. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background magenta | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:173 - -___ - -### bgRed - -▸ **bgRed**(`str`): `string` - -Set background color to red. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background red | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:153 - -___ - -### bgRgb24 - -▸ **bgRgb24**(`str`, `color`): `string` - -Set background color using 24bit rgb. -`color` can be a number in range `0x000000` to `0xffffff` or -an `Rgb`. - -To produce the color magenta: - -```ts - import { bgRgb24 } from "./colors.ts"; - bgRgb24("foo", 0xff00ff); - bgRgb24("foo", {r: 255, g: 0, b: 255}); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text color to apply 24bit rgb to | -| `color` | `number` \| [`Rgb`](../interfaces/Rgb.md) | code | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:269 - -___ - -### bgRgb8 - -▸ **bgRgb8**(`str`, `color`): `string` - -Set background color using paletted 8bit colors. -https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text color to apply paletted 8bit background colors to | -| `color` | `number` | code | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:237 - -___ - -### bgWhite - -▸ **bgWhite**(`str`): `string` - -Set background color to white. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background white | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:183 - -___ - -### bgYellow - -▸ **bgYellow**(`str`): `string` - -Set background color to yellow. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background yellow | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:163 - -___ - -### black - -▸ **black**(`str`): `string` - -Set text color to black. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make black | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:63 - -___ - -### blue - -▸ **blue**(`str`): `string` - -Set text color to blue. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make blue | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:83 - -___ - -### bold - -▸ **bold**(`str`): `string` - -Make the text bold. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bold | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:28 - -___ - -### brightBlack - -▸ **brightBlack**(`str`): `string` - -Set text color to bright black. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-black | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:108 - -___ - -### brightBlue - -▸ **brightBlue**(`str`): `string` - -Set text color to bright blue. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-blue | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:128 - -___ - -### brightCyan - -▸ **brightCyan**(`str`): `string` - -Set text color to bright cyan. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-cyan | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:138 - -___ - -### brightGreen - -▸ **brightGreen**(`str`): `string` - -Set text color to bright green. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-green | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:118 - -___ - -### brightMagenta - -▸ **brightMagenta**(`str`): `string` - -Set text color to bright magenta. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-magenta | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:133 - -___ - -### brightRed - -▸ **brightRed**(`str`): `string` - -Set text color to bright red. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-red | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:113 - -___ - -### brightWhite - -▸ **brightWhite**(`str`): `string` - -Set text color to bright white. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-white | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:143 - -___ - -### brightYellow - -▸ **brightYellow**(`str`): `string` - -Set text color to bright yellow. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-yellow | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:123 - -___ - -### calculateBits - -▸ **calculateBits**(`permissions`): `string` - -This function converts an array of permissions into the bitwise string. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `permissions` | (``"CREATE_INSTANT_INVITE"`` \| ``"KICK_MEMBERS"`` \| ``"BAN_MEMBERS"`` \| ``"ADMINISTRATOR"`` \| ``"MANAGE_CHANNELS"`` \| ``"MANAGE_GUILD"`` \| ``"ADD_REACTIONS"`` \| ``"VIEW_AUDIT_LOG"`` \| ``"PRIORITY_SPEAKER"`` \| ``"STREAM"`` \| ``"VIEW_CHANNEL"`` \| ``"SEND_MESSAGES"`` \| ``"SEND_TTS_MESSAGES"`` \| ``"MANAGE_MESSAGES"`` \| ``"EMBED_LINKS"`` \| ``"ATTACH_FILES"`` \| ``"READ_MESSAGE_HISTORY"`` \| ``"MENTION_EVERYONE"`` \| ``"USE_EXTERNAL_EMOJIS"`` \| ``"VIEW_GUILD_INSIGHTS"`` \| ``"CONNECT"`` \| ``"SPEAK"`` \| ``"MUTE_MEMBERS"`` \| ``"DEAFEN_MEMBERS"`` \| ``"MOVE_MEMBERS"`` \| ``"USE_VAD"`` \| ``"CHANGE_NICKNAME"`` \| ``"MANAGE_NICKNAMES"`` \| ``"MANAGE_ROLES"`` \| ``"MANAGE_WEBHOOKS"`` \| ``"MANAGE_EMOJIS_AND_STICKERS"`` \| ``"USE_SLASH_COMMANDS"`` \| ``"REQUEST_TO_SPEAK"`` \| ``"MANAGE_EVENTS"`` \| ``"MANAGE_THREADS"`` \| ``"CREATE_PUBLIC_THREADS"`` \| ``"CREATE_PRIVATE_THREADS"`` \| ``"USE_EXTERNAL_STICKERS"`` \| ``"SEND_MESSAGES_IN_THREADS"`` \| ``"USE_EMBEDDED_ACTIVITIES"`` \| ``"MODERATE_MEMBERS"``)[] | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/permissions.d.ts:5 - -___ - -### calculatePermissions - -▸ **calculatePermissions**(`permissionBits`): [`PermissionStrings`](md#permissionstrings)[] - -This function converts a bitwise string to permission strings - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `permissionBits` | `bigint` | - -#### Returns - -[`PermissionStrings`](md#permissionstrings)[] - -#### Defined in - -packages/utils/dist/permissions.d.ts:3 - -___ - -### camelToSnakeCase - -▸ **camelToSnakeCase**(`str`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `str` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/casing.d.ts:5 - -___ - -### camelize - -▸ **camelize**<`T`\>(`object`): [`Camelize`](md#camelize)<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `T` | - -#### Returns - -[`Camelize`](md#camelize)<`T`\> - -#### Defined in - -packages/utils/dist/casing.d.ts:2 - -___ - -### coerceToFileContent - -▸ **coerceToFileContent**(`value`): value is FileContent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `unknown` | - -#### Returns - -value is FileContent - -#### Defined in - -packages/utils/dist/files.d.ts:3 - -___ - -### createBot - -▸ **createBot**(`options`): [`Bot`](../interfaces/Bot.md) - -Create a bot object that will maintain the rest and gateway connection. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | [`CreateBotOptions`](../interfaces/CreateBotOptions.md) | Configurations options used to manage this bot. | - -#### Returns - -[`Bot`](../interfaces/Bot.md) - -Bot - -#### Defined in - -[packages/bot/src/bot.ts:62](https://github.com/discordeno/discordeno/blob/b8c25357/packages/bot/src/bot.ts#L62) - -___ - -### createGatewayManager - -▸ **createGatewayManager**(`options`): [`GatewayManager`](../interfaces/GatewayManager.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`CreateGatewayManagerOptions`](../interfaces/CreateGatewayManagerOptions.md) | - -#### Returns - -[`GatewayManager`](../interfaces/GatewayManager.md) - -#### Defined in - -packages/gateway/dist/manager.d.ts:6 - -___ - -### createInvalidRequestBucket - -▸ **createInvalidRequestBucket**(`options`): [`InvalidRequestBucket`](../interfaces/InvalidRequestBucket.md) - -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`](../interfaces/InvalidRequestBucketOptions.md) | The options used to configure this bucket. | - -#### Returns - -[`InvalidRequestBucket`](../interfaces/InvalidRequestBucket.md) - -RefillingBucket - -#### Defined in - -packages/rest/dist/invalidBucket.d.ts:9 - -___ - -### createLeakyBucket - -▸ **createLeakyBucket**(`«destructured»`): [`LeakyBucket`](../interfaces/LeakyBucket.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `«destructured»` | `Omit`<[`PickPartial`](md#pickpartial)<[`LeakyBucket`](../interfaces/LeakyBucket.md), ``"max"`` \| ``"refillInterval"`` \| ``"refillAmount"``\>, ``"tokens"``\> & { `tokens?`: `number` } | - -#### Returns - -[`LeakyBucket`](../interfaces/LeakyBucket.md) - -#### Defined in - -packages/utils/dist/bucket.d.ts:43 - -___ - -### createLogger - -▸ **createLogger**(`«destructured»?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `«destructured»` | `Object` | -| › `logLevel?` | [`LogLevels`](../enums/LogLevels.md) | -| › `name?` | `string` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `debug` | (...`args`: `any`[]) => `void` | -| `error` | (...`args`: `any`[]) => `void` | -| `fatal` | (...`args`: `any`[]) => `void` | -| `info` | (...`args`: `any`[]) => `void` | -| `log` | (`level`: [`LogLevels`](../enums/LogLevels.md), ...`args`: `any`[]) => `void` | -| `setDepth` | (`level`: [`LogDepth`](../enums/LogDepth.md)) => `void` | -| `setLevel` | (`level`: [`LogLevels`](../enums/LogLevels.md)) => `void` | -| `warn` | (...`args`: `any`[]) => `void` | - -#### Defined in - -packages/utils/dist/logger.d.ts:12 - -___ - -### createRestManager - -▸ **createRestManager**(`options`): [`RestManager`](../interfaces/RestManager.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`CreateRestManagerOptions`](../interfaces/CreateRestManagerOptions.md) | - -#### Returns - -[`RestManager`](../interfaces/RestManager.md) - -#### Defined in - -packages/rest/dist/manager.d.ts:2 - -___ - -### cyan - -▸ **cyan**(`str`): `string` - -Set text color to cyan. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make cyan | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:93 - -___ - -### decode - -▸ **decode**(`data`): `Uint8Array` - -CREDIT: https://gist.github.com/enepomnyaschih/72c423f727d395eeaa09697058238727 -Decodes RFC4648 base64 string into an Uint8Array - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Uint8Array` - -#### Defined in - -packages/utils/dist/base64.d.ts:12 - -___ - -### delay - -▸ **delay**(`ms`): `Promise`<`void`\> - -Pause the execution for a given amount of milliseconds. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ms` | `number` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/utils/dist/utils.d.ts:2 - -___ - -### dim - -▸ **dim**(`str`): `string` - -The text emits only a small amount of light. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to dim | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:33 - -___ - -### emojiUrl - -▸ **emojiUrl**(`emojiId`, `animated?`): `string` - -Get the url for an emoji. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emojiId` | [`BigString`](md#bigstring) | The id of the emoji | -| `animated?` | `boolean` | Whether or not the emoji is animated | - -#### Returns - -`string` - -string - -#### Defined in - -packages/utils/dist/images.d.ts:11 - -___ - -### encode - -▸ **encode**(`data`): `string` - -CREDIT: https://gist.github.com/enepomnyaschih/72c423f727d395eeaa09697058238727 -Encodes a given Uint8Array, ArrayBuffer or string into RFC4648 base64 representation - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` \| `ArrayBuffer` | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/base64.d.ts:6 - -___ - -### findFiles - -▸ **findFiles**(`file`): [`FileContent`](../interfaces/FileContent.md)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `file` | `unknown` | - -#### Returns - -[`FileContent`](../interfaces/FileContent.md)[] - -#### Defined in - -packages/utils/dist/files.d.ts:2 - -___ - -### formatImageUrl - -▸ **formatImageUrl**(`url`, `size?`, `format?`): `string` - -Help format an image url. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `size?` | [`ImageSize`](md#imagesize) | -| `format?` | [`ImageFormat`](md#imageformat) | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/images.d.ts:3 - -___ - -### getBotIdFromToken - -▸ **getBotIdFromToken**(`token`): `bigint` - -Get the bot id from the bot token. WARNING: Discord staff has mentioned this may not be stable forever. Use at your own risk. However, note for over 5 years this has never broken. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `token` | `string` | - -#### Returns - -`bigint` - -#### Defined in - -packages/utils/dist/token.d.ts:4 - -___ - -### getColorEnabled - -▸ **getColorEnabled**(): `boolean` - -Get whether text color change is enabled or disabled. - -#### Returns - -`boolean` - -#### Defined in - -packages/utils/dist/colors.d.ts:18 - -___ - -### getWidgetImageUrl - -▸ **getWidgetImageUrl**(`guildId`, `options?`): `string` - -Builds a URL to the guild widget image stored in the Discord CDN. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guildId` | [`BigString`](md#bigstring) | The ID of the guild to get the link to the widget image for. | -| `options?` | [`GetGuildWidgetImageQuery`](../interfaces/GetGuildWidgetImageQuery.md) | The parameters for the building of the URL. | - -#### Returns - -`string` - -The link to the resource. - -#### Defined in - -packages/utils/dist/images.d.ts:67 - -___ - -### gray - -▸ **gray**(`str`): `string` - -Set text color to gray. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make gray | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:103 - -___ - -### green - -▸ **green**(`str`): `string` - -Set text color to green. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make green | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:73 - -___ - -### guildBannerUrl - -▸ **guildBannerUrl**(`guildId`, `options`): `string` \| `undefined` - -Builds a URL to the guild banner stored in the Discord CDN. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guildId` | [`BigString`](md#bigstring) | The ID of the guild to get the link to the banner for. | -| `options` | `Object` | The parameters for the building of the URL. | -| `options.banner?` | `string` \| `bigint` | - | -| `options.format?` | [`ImageFormat`](md#imageformat) | - | -| `options.size?` | [`ImageSize`](md#imagesize) | - | - -#### Returns - -`string` \| `undefined` - -The link to the resource or `undefined` if no banner has been set. - -#### Defined in - -packages/utils/dist/images.d.ts:32 - -___ - -### guildIconUrl - -▸ **guildIconUrl**(`guildId`, `imageHash`, `options?`): `string` \| `undefined` - -Builds a URL to the guild icon stored in the Discord CDN. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guildId` | [`BigString`](md#bigstring) | The ID of the guild to get the link to the banner for. | -| `imageHash` | `undefined` \| [`BigString`](md#bigstring) | - | -| `options?` | `Object` | The parameters for the building of the URL. | -| `options.format?` | [`ImageFormat`](md#imageformat) | - | -| `options.size?` | [`ImageSize`](md#imagesize) | - | - -#### Returns - -`string` \| `undefined` - -The link to the resource or `undefined` if no banner has been set. - -#### Defined in - -packages/utils/dist/images.d.ts:44 - -___ - -### guildSplashUrl - -▸ **guildSplashUrl**(`guildId`, `imageHash`, `options?`): `string` \| `undefined` - -Builds the URL to a guild splash stored in the Discord CDN. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guildId` | [`BigString`](md#bigstring) | The ID of the guild to get the splash of. | -| `imageHash` | `undefined` \| [`BigString`](md#bigstring) | The hash identifying the splash image. | -| `options?` | `Object` | The parameters for the building of the URL. | -| `options.format?` | [`ImageFormat`](md#imageformat) | - | -| `options.size?` | [`ImageSize`](md#imagesize) | - | - -#### Returns - -`string` \| `undefined` - -The link to the resource or `undefined` if the guild does not have a splash image set. - -#### Defined in - -packages/utils/dist/images.d.ts:56 - -___ - -### hasProperty - -▸ **hasProperty**<`T`, `Y`\>(`obj`, `prop`): obj is T & Record - -TS save way to check if a property exists in an object - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Object` | -| `Y` | extends `PropertyKey` = `string` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | `T` | -| `prop` | `Y` | - -#### Returns - -obj is T & Record - -#### Defined in - -packages/utils/dist/utils.d.ts:4 - -___ - -### hidden - -▸ **hidden**(`str`): `string` - -Make the text hidden. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to hide | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:53 - -___ - -### iconBigintToHash - -▸ **iconBigintToHash**(`icon`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `icon` | `bigint` | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/hash.d.ts:2 - -___ - -### iconHashToBigInt - -▸ **iconHashToBigInt**(`hash`): `bigint` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hash` | `string` | - -#### Returns - -`bigint` - -#### Defined in - -packages/utils/dist/hash.d.ts:1 - -___ - -### inverse - -▸ **inverse**(`str`): `string` - -Invert background color and text color. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to invert its color | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:48 - -___ - -### isGetMessagesAfter - -▸ **isGetMessagesAfter**(`options`): options is GetMessagesAfter - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`GetMessagesOptions`](md#getmessagesoptions) | - -#### Returns - -options is GetMessagesAfter - -#### Defined in - -packages/utils/dist/typeguards.d.ts:2 - -___ - -### isGetMessagesAround - -▸ **isGetMessagesAround**(`options`): options is GetMessagesAround - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`GetMessagesOptions`](md#getmessagesoptions) | - -#### Returns - -options is GetMessagesAround - -#### Defined in - -packages/utils/dist/typeguards.d.ts:4 - -___ - -### isGetMessagesBefore - -▸ **isGetMessagesBefore**(`options`): options is GetMessagesBefore - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`GetMessagesOptions`](md#getmessagesoptions) | - -#### Returns - -options is GetMessagesBefore - -#### Defined in - -packages/utils/dist/typeguards.d.ts:3 - -___ - -### isGetMessagesLimit - -▸ **isGetMessagesLimit**(`options`): options is GetMessagesLimit - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`GetMessagesOptions`](md#getmessagesoptions) | - -#### Returns - -options is GetMessagesLimit - -#### Defined in - -packages/utils/dist/typeguards.d.ts:5 - -___ - -### italic - -▸ **italic**(`str`): `string` - -Make the text italic. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make italic | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:38 - -___ - -### magenta - -▸ **magenta**(`str`): `string` - -Set text color to magenta. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make magenta | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:88 - -___ - -### nextRefill - -▸ **nextRefill**(`bucket`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bucket` | [`LeakyBucket`](../interfaces/LeakyBucket.md) | - -#### Returns - -`number` - -#### Defined in - -packages/utils/dist/bucket.d.ts:53 - -___ - -### processReactionString - -▸ **processReactionString**(`reaction`): `string` - -Converts an reaction emoji unicode string to the discord required form of name:id - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `reaction` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/reactions.d.ts:2 - -___ - -### red - -▸ **red**(`str`): `string` - -Set text color to red. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make red | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:68 - -___ - -### removeTokenPrefix - -▸ **removeTokenPrefix**(`token?`, `type?`): `string` - -Removes the Bot before the token. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `token?` | `string` | -| `type?` | ``"GATEWAY"`` \| ``"REST"`` | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/token.d.ts:2 - -___ - -### reset - -▸ **reset**(`str`): `string` - -Reset the text modified - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to reset | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:23 - -___ - -### rgb24 - -▸ **rgb24**(`str`, `color`): `string` - -Set text color using 24bit rgb. -`color` can be a number in range `0x000000` to `0xffffff` or -an `Rgb`. - -To produce the color magenta: - -```ts - import { rgb24 } from "./colors.ts"; - rgb24("foo", 0xff00ff); - rgb24("foo", {r: 255, g: 0, b: 255}); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text color to apply 24bit rgb to | -| `color` | `number` \| [`Rgb`](../interfaces/Rgb.md) | code | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:253 - -___ - -### rgb8 - -▸ **rgb8**(`str`, `color`): `string` - -Set text color using paletted 8bit colors. -https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text color to apply paletted 8bit colors to | -| `color` | `number` | code | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:230 - -___ - -### setColorEnabled - -▸ **setColorEnabled**(`value`): `void` - -Set changing text color to enabled or disabled - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -packages/utils/dist/colors.d.ts:16 - -___ - -### snakeToCamelCase - -▸ **snakeToCamelCase**(`str`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `str` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/casing.d.ts:4 - -___ - -### snakelize - -▸ **snakelize**<`T`\>(`object`): [`Snakelize`](md#snakelize)<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `T` | - -#### Returns - -[`Snakelize`](md#snakelize)<`T`\> - -#### Defined in - -packages/utils/dist/casing.d.ts:3 - -___ - -### strikethrough - -▸ **strikethrough**(`str`): `string` - -Put horizontal line through the center of the text. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to strike through | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:58 - -___ - -### stripColor - -▸ **stripColor**(`string`): `string` - -Remove ANSI escape codes from the string. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `string` | `string` | to remove ANSI escape codes from | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:274 - -___ - -### underline - -▸ **underline**(`str`): `string` - -Make the text underline. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to underline | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:43 - -___ - -### updateTokens - -▸ **updateTokens**(`bucket`): `number` - -Update the tokens of that bucket. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bucket` | [`LeakyBucket`](../interfaces/LeakyBucket.md) | - -#### Returns - -`number` - -The amount of current available tokens. - -#### Defined in - -packages/utils/dist/bucket.d.ts:52 - -___ - -### urlToBase64 - -▸ **urlToBase64**(`url`): `Promise`<`string`\> - -Converts a url to base 64. Useful for example, uploading/creating server emojis. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/utils/dist/urlToBase64.d.ts:2 - -___ - -### white - -▸ **white**(`str`): `string` - -Set text color to white. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make white | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:98 - -___ - -### yellow - -▸ **yellow**(`str`): `string` - -Set text color to yellow. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make yellow | - -#### Returns - -`string` - -#### Defined in - -packages/utils/dist/colors.d.ts:78 diff --git a/website/docs/generated/modules_client.md b/website/docs/generated/modules_client.md deleted file mode 100644 index d453bab72..000000000 --- a/website/docs/generated/modules_client.md +++ /dev/null @@ -1,3289 +0,0 @@ -[discordeno-monorepo](../README.md) / [Modules](../modules.md) / @discordeno/client - -# Module: @discordeno/client - -## Table of contents - -### References - -- [default](md#default) - -### Enumerations - -- [InviteTargetTypes](../enums/InviteTargetTypes.md) - -### Classes - -- [AutocompleteInteraction](../classes/AutocompleteInteraction.md) -- [Base](../classes/Base.md) -- [CategoryChannel](../classes/CategoryChannel.md) -- [Channel](../classes/Channel.md) -- [Client](../classes/Client.md) -- [Collection](../classes/Collection.md) -- [CommandInteraction](../classes/CommandInteraction.md) -- [ComponentInteraction](../classes/ComponentInteraction.md) -- [ExtendedUser](../classes/ExtendedUser.md) -- [Guild](../classes/Guild.md) -- [GuildAuditLogEntry](../classes/GuildAuditLogEntry.md) -- [GuildChannel](../classes/GuildChannel.md) -- [GuildIntegration](../classes/GuildIntegration.md) -- [GuildPreview](../classes/GuildPreview.md) -- [GuildTemplate](../classes/GuildTemplate.md) -- [Interaction](../classes/Interaction.md) -- [Invite](../classes/Invite.md) -- [Member](../classes/Member.md) -- [Message](../classes/Message.md) -- [NewsChannel](../classes/NewsChannel.md) -- [NewsThreadChannel](../classes/NewsThreadChannel.md) -- [Permission](../classes/Permission.md) -- [PermissionOverwrite](../classes/PermissionOverwrite.md) -- [PingInteraction](../classes/PingInteraction.md) -- [PrivateChannel](../classes/PrivateChannel.md) -- [PrivateThreadChannel](../classes/PrivateThreadChannel.md) -- [PublicThreadChannel](../classes/PublicThreadChannel.md) -- [Role](../classes/Role.md) -- [Shard](../classes/Shard.md) -- [ShardManager](../classes/ShardManager.md) -- [StageChannel](../classes/StageChannel.md) -- [StageInstance](../classes/StageInstance.md) -- [TextChannel](../classes/TextChannel.md) -- [TextVoiceChannel](../classes/TextVoiceChannel.md) -- [ThreadChannel](../classes/ThreadChannel.md) -- [ThreadMember](../classes/ThreadMember.md) -- [UnavailableGuild](../classes/UnavailableGuild.md) -- [UnknownInteraction](../classes/UnknownInteraction.md) -- [User](../classes/User.md) -- [VoiceChannel](../classes/VoiceChannel.md) -- [VoiceState](../classes/VoiceState.md) - -### Interfaces - -- [ActionRow](../interfaces/ActionRow.md) -- [Activity](../interfaces/Activity.md) -- [ActivityPartial](../interfaces/ActivityPartial.md) -- [AdvancedMessageContent](../interfaces/AdvancedMessageContent.md) -- [AdvancedMessageContentEdit](../interfaces/AdvancedMessageContentEdit.md) -- [AllowedMentions](../interfaces/AllowedMentions.md) -- [ApplicationCommand](../interfaces/ApplicationCommand.md) -- [ApplicationCommandOption](../interfaces/ApplicationCommandOption.md) -- [ApplicationCommandOptionChoice](../interfaces/ApplicationCommandOptionChoice.md) -- [ApplicationCommandOptionWithChoices](../interfaces/ApplicationCommandOptionWithChoices.md) -- [ApplicationCommandOptionsSubCommand](../interfaces/ApplicationCommandOptionsSubCommand.md) -- [ApplicationCommandOptionsSubCommandGroup](../interfaces/ApplicationCommandOptionsSubCommandGroup.md) -- [ApplicationCommandPermissions](../interfaces/ApplicationCommandPermissions.md) -- [AutocompleteDisabled](../interfaces/AutocompleteDisabled.md) -- [AutocompleteDisabledInteger](../interfaces/AutocompleteDisabledInteger.md) -- [AutocompleteDisabledIntegerMinMax](../interfaces/AutocompleteDisabledIntegerMinMax.md) -- [AutocompleteEnabled](../interfaces/AutocompleteEnabled.md) -- [ButtonBase](../interfaces/ButtonBase.md) -- [ChannelFollow](../interfaces/ChannelFollow.md) -- [ChannelPosition](../interfaces/ChannelPosition.md) -- [ClientOptions](../interfaces/ClientOptions.md) -- [ClientPresence](../interfaces/ClientPresence.md) -- [CreateChannelInviteOptions](../interfaces/CreateChannelInviteOptions.md) -- [CreateChannelOptions](../interfaces/CreateChannelOptions.md) -- [CreateGuildOptions](../interfaces/CreateGuildOptions.md) -- [CreateInviteOptions](../interfaces/CreateInviteOptions.md) -- [CreateStickerOptions](../interfaces/CreateStickerOptions.md) -- [CreateThreadOptions](../interfaces/CreateThreadOptions.md) -- [CreateThreadWithoutMessageOptions](../interfaces/CreateThreadWithoutMessageOptions.md) -- [DiscoveryCategory](../interfaces/DiscoveryCategory.md) -- [DiscoveryMetadata](../interfaces/DiscoveryMetadata.md) -- [DiscoveryOptions](../interfaces/DiscoveryOptions.md) -- [DiscoverySubcategoryResponse](../interfaces/DiscoverySubcategoryResponse.md) -- [EditChannelOptions](../interfaces/EditChannelOptions.md) -- [EditChannelPositionOptions](../interfaces/EditChannelPositionOptions.md) -- [EditStickerOptions](../interfaces/EditStickerOptions.md) -- [EmbedAuthorOptions](../interfaces/EmbedAuthorOptions.md) -- [EmbedField](../interfaces/EmbedField.md) -- [EmbedFooterOptions](../interfaces/EmbedFooterOptions.md) -- [EmbedImageOptions](../interfaces/EmbedImageOptions.md) -- [EmbedOptions](../interfaces/EmbedOptions.md) -- [Emoji](../interfaces/Emoji.md) -- [EmojiBase](../interfaces/EmojiBase.md) -- [EmojiOptions](../interfaces/EmojiOptions.md) -- [FetchMembersOptions](../interfaces/FetchMembersOptions.md) -- [FileContent](../interfaces/FileContent.md) -- [GetArchivedThreadsOptions](../interfaces/GetArchivedThreadsOptions.md) -- [GetGuildAuditLogOptions](../interfaces/GetGuildAuditLogOptions.md) -- [GetGuildBansOptions](../interfaces/GetGuildBansOptions.md) -- [GetMessageReactionOptions](../interfaces/GetMessageReactionOptions.md) -- [GetMessagesOptions](../interfaces/GetMessagesOptions.md) -- [GetPruneOptions](../interfaces/GetPruneOptions.md) -- [GetRESTGuildMembersOptions](../interfaces/GetRESTGuildMembersOptions.md) -- [GetRESTGuildsOptions](../interfaces/GetRESTGuildsOptions.md) -- [GuildApplicationCommandPermissions](../interfaces/GuildApplicationCommandPermissions.md) -- [GuildAuditLog](../interfaces/GuildAuditLog.md) -- [GuildBan](../interfaces/GuildBan.md) -- [GuildOptions](../interfaces/GuildOptions.md) -- [GuildTemplateOptions](../interfaces/GuildTemplateOptions.md) -- [GuildTextable](../interfaces/GuildTextable.md) -- [GuildVanity](../interfaces/GuildVanity.md) -- [IntegrationOptions](../interfaces/IntegrationOptions.md) -- [InteractionApplicationCommandCallbackData](../interfaces/InteractionApplicationCommandCallbackData.md) -- [InteractionButton](../interfaces/InteractionButton.md) -- [InteractionResponse](../interfaces/InteractionResponse.md) -- [JSONCache](../interfaces/JSONCache.md) -- [JoinVoiceChannelOptions](../interfaces/JoinVoiceChannelOptions.md) -- [ListedChannelThreads](../interfaces/ListedChannelThreads.md) -- [ListedGuildThreads](../interfaces/ListedGuildThreads.md) -- [MemberOptions](../interfaces/MemberOptions.md) -- [MessageReferenceBase](../interfaces/MessageReferenceBase.md) -- [MessageReferenceReply](../interfaces/MessageReferenceReply.md) -- [OAuthApplicationInfo](../interfaces/OAuthApplicationInfo.md) -- [OAuthTeamInfo](../interfaces/OAuthTeamInfo.md) -- [OAuthTeamMember](../interfaces/OAuthTeamMember.md) -- [Overwrite](../interfaces/Overwrite.md) -- [ParsedClientOptions](../interfaces/ParsedClientOptions.md) -- [PartialChannel](../interfaces/PartialChannel.md) -- [PartialEmoji](../interfaces/PartialEmoji.md) -- [PartialRole](../interfaces/PartialRole.md) -- [PartialUser](../interfaces/PartialUser.md) -- [Pinnable](../interfaces/Pinnable.md) -- [PruneMemberOptions](../interfaces/PruneMemberOptions.md) -- [PurgeChannelOptions](../interfaces/PurgeChannelOptions.md) -- [RequestData](../interfaces/RequestData.md) -- [RequestGuildMembersOptions](../interfaces/RequestGuildMembersOptions.md) -- [RequestHandlerOptions](../interfaces/RequestHandlerOptions.md) -- [RequestMembersPromise](../interfaces/RequestMembersPromise.md) -- [RoleOptions](../interfaces/RoleOptions.md) -- [SelectMenu](../interfaces/SelectMenu.md) -- [SelectMenuOptions](../interfaces/SelectMenuOptions.md) -- [ShardManagerOptions](../interfaces/ShardManagerOptions.md) -- [SimpleJSON](../interfaces/SimpleJSON.md) -- [StageInstanceOptions](../interfaces/StageInstanceOptions.md) -- [Sticker](../interfaces/Sticker.md) -- [StickerItems](../interfaces/StickerItems.md) -- [StickerPack](../interfaces/StickerPack.md) -- [Textable](../interfaces/Textable.md) -- [ThreadTextable](../interfaces/ThreadTextable.md) -- [URLButton](../interfaces/URLButton.md) -- [Uncached](../interfaces/Uncached.md) -- [VoiceRegion](../interfaces/VoiceRegion.md) -- [VoiceStateOptions](../interfaces/VoiceStateOptions.md) -- [Webhook](../interfaces/Webhook.md) -- [WebhookOptions](../interfaces/WebhookOptions.md) -- [WebhookPayload](../interfaces/WebhookPayload.md) -- [WelcomeChannel](../interfaces/WelcomeChannel.md) -- [WelcomeScreen](../interfaces/WelcomeScreen.md) -- [WelcomeScreenOptions](../interfaces/WelcomeScreenOptions.md) -- [Widget](../interfaces/Widget.md) -- [WidgetChannel](../interfaces/WidgetChannel.md) -- [WidgetData](../interfaces/WidgetData.md) -- [WidgetMember](../interfaces/WidgetMember.md) - -### Type Aliases - -- [ActionRowComponents](md#actionrowcomponents) -- [ActivityType](md#activitytype) -- [AnyChannel](md#anychannel) -- [AnyGuildChannel](md#anyguildchannel) -- [AnyThreadChannel](md#anythreadchannel) -- [AnyVoiceChannel](md#anyvoicechannel) -- [ApiVersions](md#apiversions) -- [ApplicationCommandOptions](md#applicationcommandoptions) -- [ApplicationCommandOptionsBoolean](md#applicationcommandoptionsboolean) -- [ApplicationCommandOptionsChannel](md#applicationcommandoptionschannel) -- [ApplicationCommandOptionsInteger](md#applicationcommandoptionsinteger) -- [ApplicationCommandOptionsIntegerWithAutocomplete](md#applicationcommandoptionsintegerwithautocomplete) -- [ApplicationCommandOptionsIntegerWithMinMax](md#applicationcommandoptionsintegerwithminmax) -- [ApplicationCommandOptionsIntegerWithoutAutocomplete](md#applicationcommandoptionsintegerwithoutautocomplete) -- [ApplicationCommandOptionsMentionable](md#applicationcommandoptionsmentionable) -- [ApplicationCommandOptionsNumber](md#applicationcommandoptionsnumber) -- [ApplicationCommandOptionsNumberWithAutocomplete](md#applicationcommandoptionsnumberwithautocomplete) -- [ApplicationCommandOptionsNumberWithMinMax](md#applicationcommandoptionsnumberwithminmax) -- [ApplicationCommandOptionsNumberWithoutAutocomplete](md#applicationcommandoptionsnumberwithoutautocomplete) -- [ApplicationCommandOptionsRole](md#applicationcommandoptionsrole) -- [ApplicationCommandOptionsString](md#applicationcommandoptionsstring) -- [ApplicationCommandOptionsStringWithAutocomplete](md#applicationcommandoptionsstringwithautocomplete) -- [ApplicationCommandOptionsStringWithoutAutocomplete](md#applicationcommandoptionsstringwithoutautocomplete) -- [ApplicationCommandOptionsUser](md#applicationcommandoptionsuser) -- [ApplicationCommandOptionsWithValue](md#applicationcommandoptionswithvalue) -- [ApplicationCommandStructure](md#applicationcommandstructure) -- [AutoArchiveDuration](md#autoarchiveduration) -- [BigString](md#bigstring) -- [BotActivityType](md#botactivitytype) -- [Button](md#button) -- [ChatInputApplicationCommand](md#chatinputapplicationcommand) -- [ChatInputApplicationCommandStructure](md#chatinputapplicationcommandstructure) -- [GuildTextableChannel](md#guildtextablechannel) -- [ImageFormat](md#imageformat) -- [ImageSize](md#imagesize) -- [InteractionContent](md#interactioncontent) -- [InteractionContentEdit](md#interactioncontentedit) -- [MessageApplicationCommand](md#messageapplicationcommand) -- [MessageApplicationCommandStructure](md#messageapplicationcommandstructure) -- [MessageContent](md#messagecontent) -- [MessageContentEdit](md#messagecontentedit) -- [MessageWebhookContent](md#messagewebhookcontent) -- [PossiblyUncachedTextable](md#possiblyuncachedtextable) -- [RequestMethod](md#requestmethod) -- [SelfStatus](md#selfstatus) -- [Status](md#status) -- [TextVoiceChannelTypes](md#textvoicechanneltypes) -- [TextableChannel](md#textablechannel) -- [UserApplicationCommand](md#userapplicationcommand) -- [UserApplicationCommandStructure](md#userapplicationcommandstructure) -- [VideoQualityMode](md#videoqualitymode) - -### Variables - -- [CHANNELS](md#channels) -- [DISCOVERY\_CATEGORIES](md#discovery_categories) -- [DISCOVERY\_VALIDATION](md#discovery_validation) -- [GATEWAY](md#gateway) -- [GATEWAY\_BOT](md#gateway_bot) -- [GUILDS](md#guilds) -- [MessageFlags](md#messageflags) -- [STAGE\_INSTANCES](md#stage_instances) -- [STICKER\_PACKS](md#sticker_packs) -- [USERS](md#users) -- [VOICE\_REGIONS](md#voice_regions) - -### Functions - -- [ACHIEVEMENT\_ICON](md#achievement_icon) -- [APPLICATION\_ASSET](md#application_asset) -- [APPLICATION\_ICON](md#application_icon) -- [BANNER](md#banner) -- [CHANNEL](md#channel) -- [CHANNEL\_BULK\_DELETE](md#channel_bulk_delete) -- [CHANNEL\_CALL\_RING](md#channel_call_ring) -- [CHANNEL\_CROSSPOST](md#channel_crosspost) -- [CHANNEL\_FOLLOW](md#channel_follow) -- [CHANNEL\_ICON](md#channel_icon) -- [CHANNEL\_INVITES](md#channel_invites) -- [CHANNEL\_MESSAGE](md#channel_message) -- [CHANNEL\_MESSAGES](md#channel_messages) -- [CHANNEL\_MESSAGES\_SEARCH](md#channel_messages_search) -- [CHANNEL\_MESSAGE\_REACTION](md#channel_message_reaction) -- [CHANNEL\_MESSAGE\_REACTIONS](md#channel_message_reactions) -- [CHANNEL\_MESSAGE\_REACTION\_USER](md#channel_message_reaction_user) -- [CHANNEL\_PERMISSION](md#channel_permission) -- [CHANNEL\_PERMISSIONS](md#channel_permissions) -- [CHANNEL\_PIN](md#channel_pin) -- [CHANNEL\_PINS](md#channel_pins) -- [CHANNEL\_RECIPIENT](md#channel_recipient) -- [CHANNEL\_TYPING](md#channel_typing) -- [CHANNEL\_WEBHOOKS](md#channel_webhooks) -- [COMMAND](md#command) -- [COMMANDS](md#commands) -- [COMMAND\_PERMISSIONS](md#command_permissions) -- [CUSTOM\_EMOJI](md#custom_emoji) -- [CUSTOM\_EMOJI\_GUILD](md#custom_emoji_guild) -- [DEFAULT\_USER\_AVATAR](md#default_user_avatar) -- [GUILD](md#guild) -- [GUILD\_AUDIT\_LOGS](md#guild_audit_logs) -- [GUILD\_AVATAR](md#guild_avatar) -- [GUILD\_BAN](md#guild_ban) -- [GUILD\_BANS](md#guild_bans) -- [GUILD\_CHANNELS](md#guild_channels) -- [GUILD\_COMMAND](md#guild_command) -- [GUILD\_COMMANDS](md#guild_commands) -- [GUILD\_COMMAND\_PERMISSIONS](md#guild_command_permissions) -- [GUILD\_DISCOVERY](md#guild_discovery) -- [GUILD\_DISCOVERY\_CATEGORY](md#guild_discovery_category) -- [GUILD\_DISCOVERY\_SPLASH](md#guild_discovery_splash) -- [GUILD\_EMOJI](md#guild_emoji) -- [GUILD\_EMOJIS](md#guild_emojis) -- [GUILD\_ICON](md#guild_icon) -- [GUILD\_INTEGRATION](md#guild_integration) -- [GUILD\_INTEGRATIONS](md#guild_integrations) -- [GUILD\_INTEGRATION\_SYNC](md#guild_integration_sync) -- [GUILD\_INVITES](md#guild_invites) -- [GUILD\_MEMBER](md#guild_member) -- [GUILD\_MEMBERS](md#guild_members) -- [GUILD\_MEMBERS\_SEARCH](md#guild_members_search) -- [GUILD\_MEMBER\_NICK](md#guild_member_nick) -- [GUILD\_MEMBER\_ROLE](md#guild_member_role) -- [GUILD\_MESSAGES\_SEARCH](md#guild_messages_search) -- [GUILD\_PREVIEW](md#guild_preview) -- [GUILD\_PRUNE](md#guild_prune) -- [GUILD\_ROLE](md#guild_role) -- [GUILD\_ROLES](md#guild_roles) -- [GUILD\_SPLASH](md#guild_splash) -- [GUILD\_STICKER](md#guild_sticker) -- [GUILD\_STICKERS](md#guild_stickers) -- [GUILD\_TEMPLATE](md#guild_template) -- [GUILD\_TEMPLATES](md#guild_templates) -- [GUILD\_TEMPLATE\_GUILD](md#guild_template_guild) -- [GUILD\_VANITY\_URL](md#guild_vanity_url) -- [GUILD\_VOICE\_REGIONS](md#guild_voice_regions) -- [GUILD\_VOICE\_STATE](md#guild_voice_state) -- [GUILD\_WEBHOOKS](md#guild_webhooks) -- [GUILD\_WELCOME\_SCREEN](md#guild_welcome_screen) -- [GUILD\_WIDGET](md#guild_widget) -- [GUILD\_WIDGET\_SETTINGS](md#guild_widget_settings) -- [INTERACTION\_RESPOND](md#interaction_respond) -- [INVITE](md#invite) -- [MESSAGE\_LINK](md#message_link) -- [OAUTH2\_APPLICATION](md#oauth2_application) -- [ORIGINAL\_INTERACTION\_RESPONSE](md#original_interaction_response) -- [ROLE\_ICON](md#role_icon) -- [STAGE\_INSTANCE](md#stage_instance) -- [STICKER](md#sticker) -- [TEAM\_ICON](md#team_icon) -- [THREADS\_ACTIVE](md#threads_active) -- [THREADS\_ARCHIVED](md#threads_archived) -- [THREADS\_ARCHIVED\_JOINED](md#threads_archived_joined) -- [THREADS\_GUILD\_ACTIVE](md#threads_guild_active) -- [THREAD\_MEMBER](md#thread_member) -- [THREAD\_MEMBERS](md#thread_members) -- [THREAD\_WITHOUT\_MESSAGE](md#thread_without_message) -- [THREAD\_WITH\_MESSAGE](md#thread_with_message) -- [USER](md#user) -- [USER\_AVATAR](md#user_avatar) -- [USER\_BILLING](md#user_billing) -- [USER\_BILLING\_PAYMENTS](md#user_billing_payments) -- [USER\_BILLING\_PREMIUM\_SUBSCRIPTION](md#user_billing_premium_subscription) -- [USER\_CHANNELS](md#user_channels) -- [USER\_CONNECTIONS](md#user_connections) -- [USER\_CONNECTION\_PLATFORM](md#user_connection_platform) -- [USER\_GUILD](md#user_guild) -- [USER\_GUILDS](md#user_guilds) -- [USER\_MFA\_CODES](md#user_mfa_codes) -- [USER\_MFA\_TOTP\_DISABLE](md#user_mfa_totp_disable) -- [USER\_MFA\_TOTP\_ENABLE](md#user_mfa_totp_enable) -- [USER\_NOTE](md#user_note) -- [USER\_PROFILE](md#user_profile) -- [USER\_RELATIONSHIP](md#user_relationship) -- [USER\_SETTINGS](md#user_settings) -- [WEBHOOK](md#webhook) -- [WEBHOOK\_MESSAGE](md#webhook_message) -- [WEBHOOK\_SLACK](md#webhook_slack) -- [WEBHOOK\_TOKEN](md#webhook_token) -- [WEBHOOK\_TOKEN\_SLACK](md#webhook_token_slack) - -## References - -### default - -Renames and re-exports [Client](../classes/Client.md) - -## Type Aliases - -### ActionRowComponents - -Ƭ **ActionRowComponents**: [`Button`](md#button) \| [`SelectMenu`](../interfaces/SelectMenu.md) - -#### Defined in - -[packages/client/src/typings.ts:131](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L131) - -___ - -### ActivityType - -Ƭ **ActivityType**: `ActivityTypes` - -#### Defined in - -[packages/client/src/typings.ts:135](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L135) - -___ - -### AnyChannel - -Ƭ **AnyChannel**: [`AnyGuildChannel`](md#anyguildchannel) \| [`PrivateChannel`](../classes/PrivateChannel.md) \| [`PossiblyUncachedTextable`](md#possiblyuncachedtextable) - -#### Defined in - -[packages/client/src/typings.ts:120](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L120) - -___ - -### AnyGuildChannel - -Ƭ **AnyGuildChannel**: [`GuildTextableChannel`](md#guildtextablechannel) \| [`AnyVoiceChannel`](md#anyvoicechannel) \| [`CategoryChannel`](../classes/CategoryChannel.md) \| [`AnyThreadChannel`](md#anythreadchannel) - -#### Defined in - -[packages/client/src/typings.ts:121](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L121) - -___ - -### AnyThreadChannel - -Ƭ **AnyThreadChannel**: [`NewsThreadChannel`](../classes/NewsThreadChannel.md) \| [`PrivateThreadChannel`](../classes/PrivateThreadChannel.md) \| [`PublicThreadChannel`](../classes/PublicThreadChannel.md) - -#### Defined in - -[packages/client/src/typings.ts:122](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L122) - -___ - -### AnyVoiceChannel - -Ƭ **AnyVoiceChannel**: [`TextVoiceChannel`](../classes/TextVoiceChannel.md) \| [`StageChannel`](../classes/StageChannel.md) - -#### Defined in - -[packages/client/src/typings.ts:123](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L123) - -___ - -### ApiVersions - -Ƭ **ApiVersions**: ``10`` - -The API versions that are supported. - -#### Defined in - -[packages/client/src/Client.ts:2439](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Client.ts#L2439) - -___ - -### ApplicationCommandOptions - -Ƭ **ApplicationCommandOptions**: [`ApplicationCommandOptionsSubCommand`](../interfaces/ApplicationCommandOptionsSubCommand.md) \| [`ApplicationCommandOptionsSubCommandGroup`](../interfaces/ApplicationCommandOptionsSubCommandGroup.md) \| [`ApplicationCommandOptionsWithValue`](md#applicationcommandoptionswithvalue) - -#### Defined in - -[packages/client/src/typings.ts:48](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L48) - -___ - -### ApplicationCommandOptionsBoolean - -Ƭ **ApplicationCommandOptionsBoolean**: [`ApplicationCommandOption`](../interfaces/ApplicationCommandOption.md)<`ApplicationCommandOptionTypes.Boolean`\> - -#### Defined in - -[packages/client/src/typings.ts:52](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L52) - -___ - -### ApplicationCommandOptionsChannel - -Ƭ **ApplicationCommandOptionsChannel**: [`ApplicationCommandOption`](../interfaces/ApplicationCommandOption.md)<`ApplicationCommandOptionTypes.Channel`\> - -#### Defined in - -[packages/client/src/typings.ts:53](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L53) - -___ - -### ApplicationCommandOptionsInteger - -Ƭ **ApplicationCommandOptionsInteger**: [`ApplicationCommandOptionsIntegerWithAutocomplete`](md#applicationcommandoptionsintegerwithautocomplete) \| [`ApplicationCommandOptionsIntegerWithoutAutocomplete`](md#applicationcommandoptionsintegerwithoutautocomplete) \| [`ApplicationCommandOptionsIntegerWithMinMax`](md#applicationcommandoptionsintegerwithminmax) - -#### Defined in - -[packages/client/src/typings.ts:54](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L54) - -___ - -### ApplicationCommandOptionsIntegerWithAutocomplete - -Ƭ **ApplicationCommandOptionsIntegerWithAutocomplete**: `Omit`<[`ApplicationCommandOptionWithChoices`](../interfaces/ApplicationCommandOptionWithChoices.md)<`ApplicationCommandOptionTypes.Integer`\>, ``"choices"`` \| ``"min_value"`` \| ``"max_value"``\> & [`AutocompleteEnabled`](../interfaces/AutocompleteEnabled.md) - -#### Defined in - -[packages/client/src/typings.ts:58](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L58) - -___ - -### ApplicationCommandOptionsIntegerWithMinMax - -Ƭ **ApplicationCommandOptionsIntegerWithMinMax**: `Omit`<[`ApplicationCommandOptionWithChoices`](../interfaces/ApplicationCommandOptionWithChoices.md)<`ApplicationCommandOptionTypes.Integer`\>, ``"choices"`` \| ``"autocomplete"``\> & [`AutocompleteDisabledIntegerMinMax`](../interfaces/AutocompleteDisabledIntegerMinMax.md) - -#### Defined in - -[packages/client/src/typings.ts:68](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L68) - -___ - -### ApplicationCommandOptionsIntegerWithoutAutocomplete - -Ƭ **ApplicationCommandOptionsIntegerWithoutAutocomplete**: `Omit`<[`ApplicationCommandOptionWithChoices`](../interfaces/ApplicationCommandOptionWithChoices.md)<`ApplicationCommandOptionTypes.Integer`\>, ``"autocomplete"`` \| ``"min_value"`` \| ``"max_value"``\> & [`AutocompleteDisabledInteger`](../interfaces/AutocompleteDisabledInteger.md) - -#### Defined in - -[packages/client/src/typings.ts:63](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L63) - -___ - -### ApplicationCommandOptionsMentionable - -Ƭ **ApplicationCommandOptionsMentionable**: [`ApplicationCommandOption`](../interfaces/ApplicationCommandOption.md)<`ApplicationCommandOptionTypes.Mentionable`\> - -#### Defined in - -[packages/client/src/typings.ts:73](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L73) - -___ - -### ApplicationCommandOptionsNumber - -Ƭ **ApplicationCommandOptionsNumber**: [`ApplicationCommandOptionsNumberWithAutocomplete`](md#applicationcommandoptionsnumberwithautocomplete) \| [`ApplicationCommandOptionsNumberWithoutAutocomplete`](md#applicationcommandoptionsnumberwithoutautocomplete) \| [`ApplicationCommandOptionsNumberWithMinMax`](md#applicationcommandoptionsnumberwithminmax) - -#### Defined in - -[packages/client/src/typings.ts:74](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L74) - -___ - -### ApplicationCommandOptionsNumberWithAutocomplete - -Ƭ **ApplicationCommandOptionsNumberWithAutocomplete**: `Omit`<[`ApplicationCommandOptionWithChoices`](../interfaces/ApplicationCommandOptionWithChoices.md)<`ApplicationCommandOptionTypes.Number`\>, ``"choices"`` \| ``"min_value"`` \| ``"max_value"``\> & [`AutocompleteEnabled`](../interfaces/AutocompleteEnabled.md) - -#### Defined in - -[packages/client/src/typings.ts:78](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L78) - -___ - -### ApplicationCommandOptionsNumberWithMinMax - -Ƭ **ApplicationCommandOptionsNumberWithMinMax**: `Omit`<[`ApplicationCommandOptionWithChoices`](../interfaces/ApplicationCommandOptionWithChoices.md)<`ApplicationCommandOptionTypes.Number`\>, ``"choices"`` \| ``"autocomplete"``\> & [`AutocompleteDisabledIntegerMinMax`](../interfaces/AutocompleteDisabledIntegerMinMax.md) - -#### Defined in - -[packages/client/src/typings.ts:88](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L88) - -___ - -### ApplicationCommandOptionsNumberWithoutAutocomplete - -Ƭ **ApplicationCommandOptionsNumberWithoutAutocomplete**: `Omit`<[`ApplicationCommandOptionWithChoices`](../interfaces/ApplicationCommandOptionWithChoices.md)<`ApplicationCommandOptionTypes.Number`\>, ``"autocomplete"`` \| ``"min_value"`` \| ``"max_value"``\> & [`AutocompleteDisabledInteger`](../interfaces/AutocompleteDisabledInteger.md) - -#### Defined in - -[packages/client/src/typings.ts:83](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L83) - -___ - -### ApplicationCommandOptionsRole - -Ƭ **ApplicationCommandOptionsRole**: [`ApplicationCommandOption`](../interfaces/ApplicationCommandOption.md)<`ApplicationCommandOptionTypes.Role`\> - -#### Defined in - -[packages/client/src/typings.ts:93](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L93) - -___ - -### ApplicationCommandOptionsString - -Ƭ **ApplicationCommandOptionsString**: [`ApplicationCommandOptionsStringWithAutocomplete`](md#applicationcommandoptionsstringwithautocomplete) \| [`ApplicationCommandOptionsStringWithoutAutocomplete`](md#applicationcommandoptionsstringwithoutautocomplete) - -#### Defined in - -[packages/client/src/typings.ts:94](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L94) - -___ - -### ApplicationCommandOptionsStringWithAutocomplete - -Ƭ **ApplicationCommandOptionsStringWithAutocomplete**: `Omit`<[`ApplicationCommandOptionWithChoices`](../interfaces/ApplicationCommandOptionWithChoices.md)<`ApplicationCommandOptionTypes.String`\>, ``"choices"``\> & [`AutocompleteEnabled`](../interfaces/AutocompleteEnabled.md) - -#### Defined in - -[packages/client/src/typings.ts:95](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L95) - -___ - -### ApplicationCommandOptionsStringWithoutAutocomplete - -Ƭ **ApplicationCommandOptionsStringWithoutAutocomplete**: `Omit`<[`ApplicationCommandOptionWithChoices`](../interfaces/ApplicationCommandOptionWithChoices.md)<`ApplicationCommandOptionTypes.String`\>, ``"autocomplete"``\> & [`AutocompleteDisabled`](../interfaces/AutocompleteDisabled.md) - -#### Defined in - -[packages/client/src/typings.ts:100](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L100) - -___ - -### ApplicationCommandOptionsUser - -Ƭ **ApplicationCommandOptionsUser**: [`ApplicationCommandOption`](../interfaces/ApplicationCommandOption.md)<`ApplicationCommandOptionTypes.User`\> - -#### Defined in - -[packages/client/src/typings.ts:105](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L105) - -___ - -### ApplicationCommandOptionsWithValue - -Ƭ **ApplicationCommandOptionsWithValue**: [`ApplicationCommandOptionsString`](md#applicationcommandoptionsstring) \| [`ApplicationCommandOptionsInteger`](md#applicationcommandoptionsinteger) \| [`ApplicationCommandOptionsBoolean`](md#applicationcommandoptionsboolean) \| [`ApplicationCommandOptionsUser`](md#applicationcommandoptionsuser) \| [`ApplicationCommandOptionsChannel`](md#applicationcommandoptionschannel) \| [`ApplicationCommandOptionsRole`](md#applicationcommandoptionsrole) \| [`ApplicationCommandOptionsMentionable`](md#applicationcommandoptionsmentionable) \| [`ApplicationCommandOptionsNumber`](md#applicationcommandoptionsnumber) - -#### Defined in - -[packages/client/src/typings.ts:106](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L106) - -___ - -### ApplicationCommandStructure - -Ƭ **ApplicationCommandStructure**: [`ChatInputApplicationCommandStructure`](md#chatinputapplicationcommandstructure) \| [`MessageApplicationCommandStructure`](md#messageapplicationcommandstructure) \| [`UserApplicationCommandStructure`](md#userapplicationcommandstructure) - -#### Defined in - -[packages/client/src/typings.ts:41](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L41) - -___ - -### AutoArchiveDuration - -Ƭ **AutoArchiveDuration**: ``60`` \| ``1440`` \| ``4320`` \| ``10080`` - -#### Defined in - -[packages/client/src/typings.ts:139](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L139) - -___ - -### BigString - -Ƭ **BigString**: `bigint` \| `string` - -A union type of string or bigint to help make it easier for users to switch between one another. - -#### Defined in - -[packages/client/src/Client.ts:2437](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Client.ts#L2437) - -___ - -### BotActivityType - -Ƭ **BotActivityType**: `Exclude`<`ActivityTypes`, `ActivityTypes.Custom`\> - -#### Defined in - -[packages/client/src/typings.ts:136](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L136) - -___ - -### Button - -Ƭ **Button**: [`InteractionButton`](../interfaces/InteractionButton.md) \| [`URLButton`](../interfaces/URLButton.md) - -#### Defined in - -[packages/client/src/typings.ts:132](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L132) - -___ - -### ChatInputApplicationCommand - -Ƭ **ChatInputApplicationCommand**: [`ApplicationCommand`](../interfaces/ApplicationCommand.md)<`ApplicationCommandTypes.ChatInput`\> - -#### Defined in - -[packages/client/src/typings.ts:42](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L42) - -___ - -### ChatInputApplicationCommandStructure - -Ƭ **ChatInputApplicationCommandStructure**: `Omit`<[`ChatInputApplicationCommand`](md#chatinputapplicationcommand), ``"id"`` \| ``"application_id"`` \| ``"guild_id"``\> - -#### Defined in - -[packages/client/src/typings.ts:43](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L43) - -___ - -### GuildTextableChannel - -Ƭ **GuildTextableChannel**: [`TextChannel`](../classes/TextChannel.md) \| [`TextVoiceChannel`](../classes/TextVoiceChannel.md) \| [`NewsChannel`](../classes/NewsChannel.md) - -#### Defined in - -[packages/client/src/typings.ts:124](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L124) - -___ - -### ImageFormat - -Ƭ **ImageFormat**: ``"jpg"`` \| ``"jpeg"`` \| ``"png"`` \| ``"webp"`` \| ``"gif"`` - -The formats for images that are supported. - -#### Defined in - -[packages/client/src/Client.ts:2443](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Client.ts#L2443) - -___ - -### ImageSize - -Ƭ **ImageSize**: ``16`` \| ``32`` \| ``64`` \| ``128`` \| ``256`` \| ``512`` \| ``1024`` \| ``2048`` \| ``4096`` - -The sizes for images that are supported. - -#### Defined in - -[packages/client/src/Client.ts:2441](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Client.ts#L2441) - -___ - -### InteractionContent - -Ƭ **InteractionContent**: `Pick`<[`WebhookPayload`](../interfaces/WebhookPayload.md), ``"content"`` \| ``"embeds"`` \| ``"allowedMentions"`` \| ``"tts"`` \| ``"flags"`` \| ``"components"`` \| ``"file"``\> - -#### Defined in - -[packages/client/src/typings.ts:129](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L129) - -___ - -### InteractionContentEdit - -Ƭ **InteractionContentEdit**: `Pick`<[`WebhookPayload`](../interfaces/WebhookPayload.md), ``"content"`` \| ``"embeds"`` \| ``"allowedMentions"`` \| ``"components"`` \| ``"file"``\> - -#### Defined in - -[packages/client/src/typings.ts:130](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L130) - -___ - -### MessageApplicationCommand - -Ƭ **MessageApplicationCommand**: `Omit`<[`ApplicationCommand`](../interfaces/ApplicationCommand.md)<`ApplicationCommandTypes.Message`\>, ``"description"`` \| ``"options"``\> - -#### Defined in - -[packages/client/src/typings.ts:44](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L44) - -___ - -### MessageApplicationCommandStructure - -Ƭ **MessageApplicationCommandStructure**: `Omit`<[`MessageApplicationCommand`](md#messageapplicationcommand), ``"id"`` \| ``"application_id"`` \| ``"guild_id"``\> - -#### Defined in - -[packages/client/src/typings.ts:45](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L45) - -___ - -### MessageContent - -Ƭ **MessageContent**: `string` \| [`AdvancedMessageContent`](../interfaces/AdvancedMessageContent.md) - -#### Defined in - -[packages/client/src/typings.ts:133](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L133) - -___ - -### MessageContentEdit - -Ƭ **MessageContentEdit**: `string` \| [`AdvancedMessageContentEdit`](../interfaces/AdvancedMessageContentEdit.md) - -#### Defined in - -[packages/client/src/typings.ts:134](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L134) - -___ - -### MessageWebhookContent - -Ƭ **MessageWebhookContent**: `Pick`<[`WebhookPayload`](../interfaces/WebhookPayload.md), ``"content"`` \| ``"embeds"`` \| ``"file"`` \| ``"allowedMentions"`` \| ``"components"``\> - -#### Defined in - -[packages/client/src/typings.ts:140](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L140) - -___ - -### PossiblyUncachedTextable - -Ƭ **PossiblyUncachedTextable**: [`Textable`](../interfaces/Textable.md) \| [`Uncached`](../interfaces/Uncached.md) - -#### Defined in - -[packages/client/src/typings.ts:125](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L125) - -___ - -### RequestMethod - -Ƭ **RequestMethod**: ``"GET"`` \| ``"POST"`` \| ``"PUT"`` \| ``"DELETE"`` \| ``"PATCH"`` - -The methods that are acceptable for REST. - -#### Defined in - -[packages/client/src/Client.ts:2445](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Client.ts#L2445) - -___ - -### SelfStatus - -Ƭ **SelfStatus**: [`Status`](md#status) \| ``"invisible"`` - -#### Defined in - -[packages/client/src/typings.ts:138](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L138) - -___ - -### Status - -Ƭ **Status**: ``"online"`` \| ``"idle"`` \| ``"dnd"`` - -#### Defined in - -[packages/client/src/typings.ts:137](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L137) - -___ - -### TextVoiceChannelTypes - -Ƭ **TextVoiceChannelTypes**: `ChannelTypes.GuildVoice` \| `ChannelTypes.GuildStageVoice` - -#### Defined in - -[packages/client/src/typings.ts:128](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L128) - -___ - -### TextableChannel - -Ƭ **TextableChannel**: [`GuildTextable`](../interfaces/GuildTextable.md) & [`GuildTextableChannel`](md#guildtextablechannel) \| [`ThreadTextable`](../interfaces/ThreadTextable.md) & [`AnyThreadChannel`](md#anythreadchannel) \| [`Textable`](../interfaces/Textable.md) & [`PrivateChannel`](../classes/PrivateChannel.md) - -#### Defined in - -[packages/client/src/typings.ts:126](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L126) - -___ - -### UserApplicationCommand - -Ƭ **UserApplicationCommand**: `Omit`<[`ApplicationCommand`](../interfaces/ApplicationCommand.md)<`ApplicationCommandTypes.User`\>, ``"description"`` \| ``"options"``\> - -#### Defined in - -[packages/client/src/typings.ts:46](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L46) - -___ - -### UserApplicationCommandStructure - -Ƭ **UserApplicationCommandStructure**: `Omit`<[`UserApplicationCommand`](md#userapplicationcommand), ``"id"`` \| ``"application_id"`` \| ``"guild_id"``\> - -#### Defined in - -[packages/client/src/typings.ts:47](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L47) - -___ - -### VideoQualityMode - -Ƭ **VideoQualityMode**: `VideoQualityModes.Auto` \| `VideoQualityModes.Full` - -#### Defined in - -[packages/client/src/typings.ts:127](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L127) - -## Variables - -### CHANNELS - -• `Const` **CHANNELS**: ``"/channels"`` - -#### Defined in - -[packages/client/src/Endpoints.ts:30](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L30) - -___ - -### DISCOVERY\_CATEGORIES - -• `Const` **DISCOVERY\_CATEGORIES**: ``"/discovery/categories"`` - -#### Defined in - -[packages/client/src/Endpoints.ts:32](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L32) - -___ - -### DISCOVERY\_VALIDATION - -• `Const` **DISCOVERY\_VALIDATION**: ``"/discovery/valid-term"`` - -#### Defined in - -[packages/client/src/Endpoints.ts:33](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L33) - -___ - -### GATEWAY - -• `Const` **GATEWAY**: ``"/gateway"`` - -#### Defined in - -[packages/client/src/Endpoints.ts:34](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L34) - -___ - -### GATEWAY\_BOT - -• `Const` **GATEWAY\_BOT**: ``"/gateway/bot"`` - -#### Defined in - -[packages/client/src/Endpoints.ts:35](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L35) - -___ - -### GUILDS - -• `Const` **GUILDS**: ``"/guilds"`` - -#### Defined in - -[packages/client/src/Endpoints.ts:77](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L77) - -___ - -### MessageFlags - -• `Const` **MessageFlags**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `CROSSPOSTED` | `number` | -| `EPHEMERAL` | `number` | -| `HAS_THREAD` | `number` | -| `IS_CROSSPOST` | `number` | -| `LOADING` | `number` | -| `SOURCE_MESSAGE_DELETED` | `number` | -| `SUPPRESS_EMBEDS` | `number` | -| `URGENT` | `number` | - -#### Defined in - -[packages/client/src/typings.ts:878](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/typings.ts#L878) - -___ - -### STAGE\_INSTANCES - -• `Const` **STAGE\_INSTANCES**: ``"/stage-instances"`` - -#### Defined in - -[packages/client/src/Endpoints.ts:82](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L82) - -___ - -### STICKER\_PACKS - -• `Const` **STICKER\_PACKS**: ``"/sticker-packs"`` - -#### Defined in - -[packages/client/src/Endpoints.ts:84](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L84) - -___ - -### USERS - -• `Const` **USERS**: ``"/users"`` - -#### Defined in - -[packages/client/src/Endpoints.ts:109](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L109) - -___ - -### VOICE\_REGIONS - -• `Const` **VOICE\_REGIONS**: ``"/voice/regions"`` - -#### Defined in - -[packages/client/src/Endpoints.ts:110](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L110) - -## Functions - -### ACHIEVEMENT\_ICON - -▸ **ACHIEVEMENT_ICON**(`applicationID`, `achievementID`, `icon`): `string` - -CDN Endpoints - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `applicationID` | [`BigString`](md#bigstring) | -| `achievementID` | [`BigString`](md#bigstring) | -| `icon` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:118](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L118) - -___ - -### APPLICATION\_ASSET - -▸ **APPLICATION_ASSET**(`applicationID`, `asset`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `applicationID` | [`BigString`](md#bigstring) | -| `asset` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:120](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L120) - -___ - -### APPLICATION\_ICON - -▸ **APPLICATION_ICON**(`applicationID`, `icon`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `applicationID` | [`BigString`](md#bigstring) | -| `icon` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:121](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L121) - -___ - -### BANNER - -▸ **BANNER**(`guildOrUserID`, `hash`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildOrUserID` | [`BigString`](md#bigstring) | -| `hash` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:122](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L122) - -___ - -### CHANNEL - -▸ **CHANNEL**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:9](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L9) - -___ - -### CHANNEL\_BULK\_DELETE - -▸ **CHANNEL_BULK_DELETE**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:10](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L10) - -___ - -### CHANNEL\_CALL\_RING - -▸ **CHANNEL_CALL_RING**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:11](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L11) - -___ - -### CHANNEL\_CROSSPOST - -▸ **CHANNEL_CROSSPOST**(`chanID`, `msgID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | -| `msgID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:12](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L12) - -___ - -### CHANNEL\_FOLLOW - -▸ **CHANNEL_FOLLOW**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:13](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L13) - -___ - -### CHANNEL\_ICON - -▸ **CHANNEL_ICON**(`chanID`, `chanIcon`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | -| `chanIcon` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:123](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L123) - -___ - -### CHANNEL\_INVITES - -▸ **CHANNEL_INVITES**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:14](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L14) - -___ - -### CHANNEL\_MESSAGE - -▸ **CHANNEL_MESSAGE**(`chanID`, `msgID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | -| `msgID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:20](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L20) - -___ - -### CHANNEL\_MESSAGES - -▸ **CHANNEL_MESSAGES**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:21](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L21) - -___ - -### CHANNEL\_MESSAGES\_SEARCH - -▸ **CHANNEL_MESSAGES_SEARCH**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:22](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L22) - -___ - -### CHANNEL\_MESSAGE\_REACTION - -▸ **CHANNEL_MESSAGE_REACTION**(`chanID`, `msgID`, `reaction`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | -| `msgID` | [`BigString`](md#bigstring) | -| `reaction` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:15](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L15) - -___ - -### CHANNEL\_MESSAGE\_REACTIONS - -▸ **CHANNEL_MESSAGE_REACTIONS**(`chanID`, `msgID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | -| `msgID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:19](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L19) - -___ - -### CHANNEL\_MESSAGE\_REACTION\_USER - -▸ **CHANNEL_MESSAGE_REACTION_USER**(`chanID`, `msgID`, `reaction`, `userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | -| `msgID` | [`BigString`](md#bigstring) | -| `reaction` | `string` | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:17](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L17) - -___ - -### CHANNEL\_PERMISSION - -▸ **CHANNEL_PERMISSION**(`chanID`, `overID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | -| `overID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:23](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L23) - -___ - -### CHANNEL\_PERMISSIONS - -▸ **CHANNEL_PERMISSIONS**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:24](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L24) - -___ - -### CHANNEL\_PIN - -▸ **CHANNEL_PIN**(`chanID`, `msgID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | -| `msgID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:25](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L25) - -___ - -### CHANNEL\_PINS - -▸ **CHANNEL_PINS**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:26](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L26) - -___ - -### CHANNEL\_RECIPIENT - -▸ **CHANNEL_RECIPIENT**(`groupID`, `userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `groupID` | [`BigString`](md#bigstring) | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:27](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L27) - -___ - -### CHANNEL\_TYPING - -▸ **CHANNEL_TYPING**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:28](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L28) - -___ - -### CHANNEL\_WEBHOOKS - -▸ **CHANNEL_WEBHOOKS**(`chanID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chanID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:29](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L29) - -___ - -### COMMAND - -▸ **COMMAND**(`applicationID`, `commandID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `applicationID` | [`BigString`](md#bigstring) | -| `commandID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:5](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L5) - -___ - -### COMMANDS - -▸ **COMMANDS**(`applicationID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `applicationID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:6](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L6) - -___ - -### COMMAND\_PERMISSIONS - -▸ **COMMAND_PERMISSIONS**(`applicationID`, `guildID`, `commandID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `applicationID` | [`BigString`](md#bigstring) | -| `guildID` | [`BigString`](md#bigstring) | -| `commandID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:7](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L7) - -___ - -### CUSTOM\_EMOJI - -▸ **CUSTOM_EMOJI**(`emojiID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emojiID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:124](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L124) - -___ - -### CUSTOM\_EMOJI\_GUILD - -▸ **CUSTOM_EMOJI_GUILD**(`emojiID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emojiID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:31](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L31) - -___ - -### DEFAULT\_USER\_AVATAR - -▸ **DEFAULT_USER_AVATAR**(`userDiscriminator`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userDiscriminator` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:125](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L125) - -___ - -### GUILD - -▸ **GUILD**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:36](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L36) - -___ - -### GUILD\_AUDIT\_LOGS - -▸ **GUILD_AUDIT_LOGS**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:37](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L37) - -___ - -### GUILD\_AVATAR - -▸ **GUILD_AVATAR**(`guildID`, `userID`, `guildAvatar`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `userID` | [`BigString`](md#bigstring) | -| `guildAvatar` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:126](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L126) - -___ - -### GUILD\_BAN - -▸ **GUILD_BAN**(`guildID`, `memberID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `memberID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:38](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L38) - -___ - -### GUILD\_BANS - -▸ **GUILD_BANS**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:39](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L39) - -___ - -### GUILD\_CHANNELS - -▸ **GUILD_CHANNELS**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:40](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L40) - -___ - -### GUILD\_COMMAND - -▸ **GUILD_COMMAND**(`applicationID`, `guildID`, `commandID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `applicationID` | [`BigString`](md#bigstring) | -| `guildID` | [`BigString`](md#bigstring) | -| `commandID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:41](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L41) - -___ - -### GUILD\_COMMANDS - -▸ **GUILD_COMMANDS**(`applicationID`, `guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `applicationID` | [`BigString`](md#bigstring) | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:45](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L45) - -___ - -### GUILD\_COMMAND\_PERMISSIONS - -▸ **GUILD_COMMAND_PERMISSIONS**(`applicationID`, `guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `applicationID` | [`BigString`](md#bigstring) | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:43](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L43) - -___ - -### GUILD\_DISCOVERY - -▸ **GUILD_DISCOVERY**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:46](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L46) - -___ - -### GUILD\_DISCOVERY\_CATEGORY - -▸ **GUILD_DISCOVERY_CATEGORY**(`guildID`, `categoryID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `categoryID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:47](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L47) - -___ - -### GUILD\_DISCOVERY\_SPLASH - -▸ **GUILD_DISCOVERY_SPLASH**(`guildID`, `guildDiscoverySplash`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `guildDiscoverySplash` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:128](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L128) - -___ - -### GUILD\_EMOJI - -▸ **GUILD_EMOJI**(`guildID`, `emojiID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `emojiID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:48](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L48) - -___ - -### GUILD\_EMOJIS - -▸ **GUILD_EMOJIS**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:49](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L49) - -___ - -### GUILD\_ICON - -▸ **GUILD_ICON**(`guildID`, `guildIcon`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `guildIcon` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:129](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L129) - -___ - -### GUILD\_INTEGRATION - -▸ **GUILD_INTEGRATION**(`guildID`, `inteID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `inteID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:50](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L50) - -___ - -### GUILD\_INTEGRATIONS - -▸ **GUILD_INTEGRATIONS**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:52](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L52) - -___ - -### GUILD\_INTEGRATION\_SYNC - -▸ **GUILD_INTEGRATION_SYNC**(`guildID`, `inteID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `inteID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:51](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L51) - -___ - -### GUILD\_INVITES - -▸ **GUILD_INVITES**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:53](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L53) - -___ - -### GUILD\_MEMBER - -▸ **GUILD_MEMBER**(`guildID`, `memberID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `memberID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:55](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L55) - -___ - -### GUILD\_MEMBERS - -▸ **GUILD_MEMBERS**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:59](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L59) - -___ - -### GUILD\_MEMBERS\_SEARCH - -▸ **GUILD_MEMBERS_SEARCH**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:60](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L60) - -___ - -### GUILD\_MEMBER\_NICK - -▸ **GUILD_MEMBER_NICK**(`guildID`, `memberID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `memberID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:56](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L56) - -___ - -### GUILD\_MEMBER\_ROLE - -▸ **GUILD_MEMBER_ROLE**(`guildID`, `memberID`, `roleID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `memberID` | [`BigString`](md#bigstring) | -| `roleID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:57](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L57) - -___ - -### GUILD\_MESSAGES\_SEARCH - -▸ **GUILD_MESSAGES_SEARCH**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:61](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L61) - -___ - -### GUILD\_PREVIEW - -▸ **GUILD_PREVIEW**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:62](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L62) - -___ - -### GUILD\_PRUNE - -▸ **GUILD_PRUNE**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:63](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L63) - -___ - -### GUILD\_ROLE - -▸ **GUILD_ROLE**(`guildID`, `roleID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `roleID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:64](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L64) - -___ - -### GUILD\_ROLES - -▸ **GUILD_ROLES**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:65](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L65) - -___ - -### GUILD\_SPLASH - -▸ **GUILD_SPLASH**(`guildID`, `guildSplash`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `guildSplash` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:130](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L130) - -___ - -### GUILD\_STICKER - -▸ **GUILD_STICKER**(`guildID`, `stickerID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `stickerID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:66](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L66) - -___ - -### GUILD\_STICKERS - -▸ **GUILD_STICKERS**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:67](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L67) - -___ - -### GUILD\_TEMPLATE - -▸ **GUILD_TEMPLATE**(`code`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:68](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L68) - -___ - -### GUILD\_TEMPLATES - -▸ **GUILD_TEMPLATES**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:69](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L69) - -___ - -### GUILD\_TEMPLATE\_GUILD - -▸ **GUILD_TEMPLATE_GUILD**(`guildID`, `code`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `code` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:70](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L70) - -___ - -### GUILD\_VANITY\_URL - -▸ **GUILD_VANITY_URL**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:54](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L54) - -___ - -### GUILD\_VOICE\_REGIONS - -▸ **GUILD_VOICE_REGIONS**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:71](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L71) - -___ - -### GUILD\_VOICE\_STATE - -▸ **GUILD_VOICE_STATE**(`guildID`, `user`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `user` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:76](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L76) - -___ - -### GUILD\_WEBHOOKS - -▸ **GUILD_WEBHOOKS**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:72](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L72) - -___ - -### GUILD\_WELCOME\_SCREEN - -▸ **GUILD_WELCOME_SCREEN**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:73](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L73) - -___ - -### GUILD\_WIDGET - -▸ **GUILD_WIDGET**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:74](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L74) - -___ - -### GUILD\_WIDGET\_SETTINGS - -▸ **GUILD_WIDGET_SETTINGS**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:75](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L75) - -___ - -### INTERACTION\_RESPOND - -▸ **INTERACTION_RESPOND**(`interactID`, `interactToken`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `interactID` | [`BigString`](md#bigstring) | -| `interactToken` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:78](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L78) - -___ - -### INVITE - -▸ **INVITE**(`inviteID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `inviteID` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:79](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L79) - -___ - -### MESSAGE\_LINK - -▸ **MESSAGE_LINK**(`guildID`, `channelID`, `messageID`): `string` - -Client Endpoints - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | -| `channelID` | [`BigString`](md#bigstring) | -| `messageID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:136](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L136) - -___ - -### OAUTH2\_APPLICATION - -▸ **OAUTH2_APPLICATION**(`appID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `appID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:80](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L80) - -___ - -### ORIGINAL\_INTERACTION\_RESPONSE - -▸ **ORIGINAL_INTERACTION_RESPONSE**(`appID`, `interactToken`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `appID` | [`BigString`](md#bigstring) | -| `interactToken` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:4](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L4) - -___ - -### ROLE\_ICON - -▸ **ROLE_ICON**(`roleID`, `roleIcon`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `roleID` | [`BigString`](md#bigstring) | -| `roleIcon` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:131](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L131) - -___ - -### STAGE\_INSTANCE - -▸ **STAGE_INSTANCE**(`channelID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `channelID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:81](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L81) - -___ - -### STICKER - -▸ **STICKER**(`stickerID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `stickerID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:83](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L83) - -___ - -### TEAM\_ICON - -▸ **TEAM_ICON**(`teamID`, `teamIcon`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `teamID` | [`BigString`](md#bigstring) | -| `teamIcon` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:132](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L132) - -___ - -### THREADS\_ACTIVE - -▸ **THREADS_ACTIVE**(`channelID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `channelID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:89](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L89) - -___ - -### THREADS\_ARCHIVED - -▸ **THREADS_ARCHIVED**(`channelID`, `type`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `channelID` | [`BigString`](md#bigstring) | -| `type` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:90](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L90) - -___ - -### THREADS\_ARCHIVED\_JOINED - -▸ **THREADS_ARCHIVED_JOINED**(`channelID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `channelID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:91](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L91) - -___ - -### THREADS\_GUILD\_ACTIVE - -▸ **THREADS_GUILD_ACTIVE**(`guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:92](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L92) - -___ - -### THREAD\_MEMBER - -▸ **THREAD_MEMBER**(`channelID`, `userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `channelID` | [`BigString`](md#bigstring) | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:85](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L85) - -___ - -### THREAD\_MEMBERS - -▸ **THREAD_MEMBERS**(`channelID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `channelID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:86](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L86) - -___ - -### THREAD\_WITHOUT\_MESSAGE - -▸ **THREAD_WITHOUT_MESSAGE**(`channelID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `channelID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:88](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L88) - -___ - -### THREAD\_WITH\_MESSAGE - -▸ **THREAD_WITH_MESSAGE**(`channelID`, `msgID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `channelID` | [`BigString`](md#bigstring) | -| `msgID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:87](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L87) - -___ - -### USER - -▸ **USER**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:93](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L93) - -___ - -### USER\_AVATAR - -▸ **USER_AVATAR**(`userID`, `userAvatar`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | -| `userAvatar` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:133](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L133) - -___ - -### USER\_BILLING - -▸ **USER_BILLING**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:94](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L94) - -___ - -### USER\_BILLING\_PAYMENTS - -▸ **USER_BILLING_PAYMENTS**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:95](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L95) - -___ - -### USER\_BILLING\_PREMIUM\_SUBSCRIPTION - -▸ **USER_BILLING_PREMIUM_SUBSCRIPTION**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:96](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L96) - -___ - -### USER\_CHANNELS - -▸ **USER_CHANNELS**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:97](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L97) - -___ - -### USER\_CONNECTIONS - -▸ **USER_CONNECTIONS**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:98](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L98) - -___ - -### USER\_CONNECTION\_PLATFORM - -▸ **USER_CONNECTION_PLATFORM**(`userID`, `platform`, `id`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | -| `platform` | `string` | -| `id` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:99](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L99) - -___ - -### USER\_GUILD - -▸ **USER_GUILD**(`userID`, `guildID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | -| `guildID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:100](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L100) - -___ - -### USER\_GUILDS - -▸ **USER_GUILDS**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:101](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L101) - -___ - -### USER\_MFA\_CODES - -▸ **USER_MFA_CODES**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:102](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L102) - -___ - -### USER\_MFA\_TOTP\_DISABLE - -▸ **USER_MFA_TOTP_DISABLE**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:103](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L103) - -___ - -### USER\_MFA\_TOTP\_ENABLE - -▸ **USER_MFA_TOTP_ENABLE**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:104](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L104) - -___ - -### USER\_NOTE - -▸ **USER_NOTE**(`userID`, `targetID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | -| `targetID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:105](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L105) - -___ - -### USER\_PROFILE - -▸ **USER_PROFILE**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:106](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L106) - -___ - -### USER\_RELATIONSHIP - -▸ **USER_RELATIONSHIP**(`userID`, `relID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | -| `relID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:107](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L107) - -___ - -### USER\_SETTINGS - -▸ **USER_SETTINGS**(`userID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `userID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:108](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L108) - -___ - -### WEBHOOK - -▸ **WEBHOOK**(`hookID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hookID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:111](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L111) - -___ - -### WEBHOOK\_MESSAGE - -▸ **WEBHOOK_MESSAGE**(`hookID`, `token`, `msgID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hookID` | [`BigString`](md#bigstring) | -| `token` | `string` | -| `msgID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:112](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L112) - -___ - -### WEBHOOK\_SLACK - -▸ **WEBHOOK_SLACK**(`hookID`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hookID` | [`BigString`](md#bigstring) | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:113](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L113) - -___ - -### WEBHOOK\_TOKEN - -▸ **WEBHOOK_TOKEN**(`hookID`, `token`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hookID` | [`BigString`](md#bigstring) | -| `token` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:114](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L114) - -___ - -### WEBHOOK\_TOKEN\_SLACK - -▸ **WEBHOOK_TOKEN_SLACK**(`hookID`, `token`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hookID` | [`BigString`](md#bigstring) | -| `token` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client/src/Endpoints.ts:115](https://github.com/discordeno/discordeno/blob/b8c25357/packages/client/src/Endpoints.ts#L115) diff --git a/website/docs/generated/modules_gateway.md b/website/docs/generated/modules_gateway.md deleted file mode 100644 index 589d39ff4..000000000 --- a/website/docs/generated/modules_gateway.md +++ /dev/null @@ -1,53 +0,0 @@ -[discordeno-monorepo](../README.md) / [Modules](../modules.md) / @discordeno/gateway - -# Module: @discordeno/gateway - -## Table of contents - -### Enumerations - -- [ShardSocketCloseCodes](../enums/ShardSocketCloseCodes.md) -- [ShardState](../enums/ShardState.md) - -### Classes - -- [DiscordenoShard](../classes/DiscordenoShard.md) - -### Interfaces - -- [BotActivity](../interfaces/BotActivity.md) -- [BotStatusUpdate](../interfaces/BotStatusUpdate.md) -- [CreateGatewayManagerOptions](../interfaces/CreateGatewayManagerOptions.md) -- [GatewayManager](../interfaces/GatewayManager.md) -- [RequestMemberRequest](../interfaces/RequestMemberRequest.md) -- [ShardCreateOptions](../interfaces/ShardCreateOptions.md) -- [ShardEvents](../interfaces/ShardEvents.md) -- [ShardGatewayConfig](../interfaces/ShardGatewayConfig.md) -- [ShardHeart](../interfaces/ShardHeart.md) -- [ShardSocketRequest](../interfaces/ShardSocketRequest.md) -- [StatusUpdate](../interfaces/StatusUpdate.md) -- [UpdateVoiceState](../interfaces/UpdateVoiceState.md) - -### Functions - -- [createGatewayManager](md#creategatewaymanager) - -## Functions - -### createGatewayManager - -▸ **createGatewayManager**(`options`): [`GatewayManager`](../interfaces/GatewayManager.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`CreateGatewayManagerOptions`](../interfaces/CreateGatewayManagerOptions.md) | - -#### Returns - -[`GatewayManager`](../interfaces/GatewayManager.md) - -#### Defined in - -[packages/gateway/src/manager.ts:7](https://github.com/discordeno/discordeno/blob/b8c25357/packages/gateway/src/manager.ts#L7) diff --git a/website/docs/generated/modules_rest.md b/website/docs/generated/modules_rest.md deleted file mode 100644 index 27b3effc8..000000000 --- a/website/docs/generated/modules_rest.md +++ /dev/null @@ -1,101 +0,0 @@ -[discordeno-monorepo](../README.md) / [Modules](../modules.md) / @discordeno/rest - -# Module: @discordeno/rest - -## Table of contents - -### Classes - -- [Queue](../classes/Queue.md) - -### Interfaces - -- [CreateRequestBodyOptions](../interfaces/CreateRequestBodyOptions.md) -- [CreateRestManagerOptions](../interfaces/CreateRestManagerOptions.md) -- [CreateWebhook](../interfaces/CreateWebhook.md) -- [InvalidRequestBucket](../interfaces/InvalidRequestBucket.md) -- [InvalidRequestBucketOptions](../interfaces/InvalidRequestBucketOptions.md) -- [QueueOptions](../interfaces/QueueOptions.md) -- [RequestBody](../interfaces/RequestBody.md) -- [RestManager](../interfaces/RestManager.md) -- [RestRateLimitedPath](../interfaces/RestRateLimitedPath.md) -- [RestRequestRejection](../interfaces/RestRequestRejection.md) -- [RestRequestResponse](../interfaces/RestRequestResponse.md) -- [RestRoutes](../interfaces/RestRoutes.md) -- [SendRequestOptions](../interfaces/SendRequestOptions.md) -- [WebhookMessageEditor](../interfaces/WebhookMessageEditor.md) - -### Type Aliases - -- [ApiVersions](md#apiversions) -- [RequestMethods](md#requestmethods) - -### Functions - -- [createInvalidRequestBucket](md#createinvalidrequestbucket) -- [createRestManager](md#createrestmanager) - -## Type Aliases - -### ApiVersions - -Ƭ **ApiVersions**: ``9`` \| ``10`` - -#### Defined in - -[packages/rest/src/types.ts:2439](https://github.com/discordeno/discordeno/blob/b8c25357/packages/rest/src/types.ts#L2439) - -___ - -### RequestMethods - -Ƭ **RequestMethods**: ``"GET"`` \| ``"POST"`` \| ``"DELETE"`` \| ``"PATCH"`` \| ``"PUT"`` - -#### Defined in - -[packages/rest/src/types.ts:2438](https://github.com/discordeno/discordeno/blob/b8c25357/packages/rest/src/types.ts#L2438) - -## Functions - -### createInvalidRequestBucket - -▸ **createInvalidRequestBucket**(`options`): [`InvalidRequestBucket`](../interfaces/InvalidRequestBucket.md) - -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`](../interfaces/InvalidRequestBucketOptions.md) | The options used to configure this bucket. | - -#### Returns - -[`InvalidRequestBucket`](../interfaces/InvalidRequestBucket.md) - -RefillingBucket - -#### Defined in - -[packages/rest/src/invalidBucket.ts:10](https://github.com/discordeno/discordeno/blob/b8c25357/packages/rest/src/invalidBucket.ts#L10) - -___ - -### createRestManager - -▸ **createRestManager**(`options`): [`RestManager`](../interfaces/RestManager.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`CreateRestManagerOptions`](../interfaces/CreateRestManagerOptions.md) | - -#### Returns - -[`RestManager`](../interfaces/RestManager.md) - -#### Defined in - -[packages/rest/src/manager.ts:72](https://github.com/discordeno/discordeno/blob/b8c25357/packages/rest/src/manager.ts#L72) diff --git a/website/docs/generated/modules_types.md b/website/docs/generated/modules_types.md deleted file mode 100644 index 5216c4bf0..000000000 --- a/website/docs/generated/modules_types.md +++ /dev/null @@ -1,585 +0,0 @@ -[discordeno-monorepo](../README.md) / [Modules](../modules.md) / @discordeno/types - -# Module: @discordeno/types - -## Table of contents - -### Enumerations - -- [ActivityTypes](../enums/ActivityTypes.md) -- [AllowedMentionsTypes](../enums/AllowedMentionsTypes.md) -- [ApplicationCommandOptionTypes](../enums/ApplicationCommandOptionTypes.md) -- [ApplicationCommandPermissionTypes](../enums/ApplicationCommandPermissionTypes.md) -- [ApplicationCommandTypes](../enums/ApplicationCommandTypes.md) -- [ApplicationFlags](../enums/ApplicationFlags.md) -- [AuditLogEvents](../enums/AuditLogEvents.md) -- [AutoModerationActionType](../enums/AutoModerationActionType.md) -- [AutoModerationEventTypes](../enums/AutoModerationEventTypes.md) -- [AutoModerationTriggerTypes](../enums/AutoModerationTriggerTypes.md) -- [BitwisePermissionFlags](../enums/BitwisePermissionFlags.md) -- [ButtonStyles](../enums/ButtonStyles.md) -- [ChannelFlags](../enums/ChannelFlags.md) -- [ChannelTypes](../enums/ChannelTypes.md) -- [DefaultMessageNotificationLevels](../enums/DefaultMessageNotificationLevels.md) -- [DiscordAutoModerationRuleTriggerMetadataPresets](../enums/DiscordAutoModerationRuleTriggerMetadataPresets.md) -- [ExplicitContentFilterLevels](../enums/ExplicitContentFilterLevels.md) -- [GatewayCloseEventCodes](../enums/GatewayCloseEventCodes.md) -- [GatewayIntents](../enums/GatewayIntents.md) -- [GatewayOpcodes](../enums/GatewayOpcodes.md) -- [GuildFeatures](../enums/GuildFeatures.md) -- [GuildNsfwLevel](../enums/GuildNsfwLevel.md) -- [IntegrationExpireBehaviors](../enums/IntegrationExpireBehaviors.md) -- [InteractionResponseTypes](../enums/InteractionResponseTypes.md) -- [InteractionTypes](../enums/InteractionTypes.md) -- [Locales](../enums/Locales.md) -- [MessageActivityTypes](../enums/MessageActivityTypes.md) -- [MessageComponentTypes](../enums/MessageComponentTypes.md) -- [MessageTypes](../enums/MessageTypes.md) -- [MfaLevels](../enums/MfaLevels.md) -- [OverwriteTypes](../enums/OverwriteTypes.md) -- [PremiumTiers](../enums/PremiumTiers.md) -- [PremiumTypes](../enums/PremiumTypes.md) -- [PresenceStatus](../enums/PresenceStatus.md) -- [ScheduledEventEntityType](../enums/ScheduledEventEntityType.md) -- [ScheduledEventPrivacyLevel](../enums/ScheduledEventPrivacyLevel.md) -- [ScheduledEventStatus](../enums/ScheduledEventStatus.md) -- [SortOrderTypes](../enums/SortOrderTypes.md) -- [StickerFormatTypes](../enums/StickerFormatTypes.md) -- [StickerTypes](../enums/StickerTypes.md) -- [SystemChannelFlags](../enums/SystemChannelFlags.md) -- [TargetTypes](../enums/TargetTypes.md) -- [TeamMembershipStates](../enums/TeamMembershipStates.md) -- [TextStyles](../enums/TextStyles.md) -- [UserFlags](../enums/UserFlags.md) -- [VerificationLevels](../enums/VerificationLevels.md) -- [VideoQualityModes](../enums/VideoQualityModes.md) -- [WebhookTypes](../enums/WebhookTypes.md) - -### Interfaces - -- [ActionRow](../interfaces/ActionRow.md) -- [AllowedMentions](../interfaces/AllowedMentions.md) -- [ApplicationCommandOption](../interfaces/ApplicationCommandOption.md) -- [ApplicationCommandOptionChoice](../interfaces/ApplicationCommandOptionChoice.md) -- [ApplicationCommandPermissions](../interfaces/ApplicationCommandPermissions.md) -- [BeginGuildPrune](../interfaces/BeginGuildPrune.md) -- [ButtonComponent](../interfaces/ButtonComponent.md) -- [CreateAutoModerationRuleOptions](../interfaces/CreateAutoModerationRuleOptions.md) -- [CreateChannelInvite](../interfaces/CreateChannelInvite.md) -- [CreateContextApplicationCommand](../interfaces/CreateContextApplicationCommand.md) -- [CreateForumPostWithMessage](../interfaces/CreateForumPostWithMessage.md) -- [CreateGuild](../interfaces/CreateGuild.md) -- [CreateGuildBan](../interfaces/CreateGuildBan.md) -- [CreateGuildChannel](../interfaces/CreateGuildChannel.md) -- [CreateGuildEmoji](../interfaces/CreateGuildEmoji.md) -- [CreateGuildFromTemplate](../interfaces/CreateGuildFromTemplate.md) -- [CreateGuildRole](../interfaces/CreateGuildRole.md) -- [CreateGuildStickerOptions](../interfaces/CreateGuildStickerOptions.md) -- [CreateMessageOptions](../interfaces/CreateMessageOptions.md) -- [CreateScheduledEvent](../interfaces/CreateScheduledEvent.md) -- [CreateSlashApplicationCommand](../interfaces/CreateSlashApplicationCommand.md) -- [CreateStageInstance](../interfaces/CreateStageInstance.md) -- [CreateTemplate](../interfaces/CreateTemplate.md) -- [DeleteWebhookMessageOptions](../interfaces/DeleteWebhookMessageOptions.md) -- [DiscordActionRow](../interfaces/DiscordActionRow.md) -- [DiscordActiveThreads](../interfaces/DiscordActiveThreads.md) -- [DiscordActivity](../interfaces/DiscordActivity.md) -- [DiscordActivityAssets](../interfaces/DiscordActivityAssets.md) -- [DiscordActivityButton](../interfaces/DiscordActivityButton.md) -- [DiscordActivityEmoji](../interfaces/DiscordActivityEmoji.md) -- [DiscordActivityParty](../interfaces/DiscordActivityParty.md) -- [DiscordActivitySecrets](../interfaces/DiscordActivitySecrets.md) -- [DiscordActivityTimestamps](../interfaces/DiscordActivityTimestamps.md) -- [DiscordAllowedMentions](../interfaces/DiscordAllowedMentions.md) -- [DiscordApplication](../interfaces/DiscordApplication.md) -- [DiscordApplicationCommand](../interfaces/DiscordApplicationCommand.md) -- [DiscordApplicationCommandOption](../interfaces/DiscordApplicationCommandOption.md) -- [DiscordApplicationCommandOptionChoice](../interfaces/DiscordApplicationCommandOptionChoice.md) -- [DiscordApplicationCommandPermissions](../interfaces/DiscordApplicationCommandPermissions.md) -- [DiscordApplicationWebhook](../interfaces/DiscordApplicationWebhook.md) -- [DiscordAttachment](../interfaces/DiscordAttachment.md) -- [DiscordAuditLog](../interfaces/DiscordAuditLog.md) -- [DiscordAuditLogEntry](../interfaces/DiscordAuditLogEntry.md) -- [DiscordAutoModerationAction](../interfaces/DiscordAutoModerationAction.md) -- [DiscordAutoModerationActionExecution](../interfaces/DiscordAutoModerationActionExecution.md) -- [DiscordAutoModerationActionMetadata](../interfaces/DiscordAutoModerationActionMetadata.md) -- [DiscordAutoModerationRule](../interfaces/DiscordAutoModerationRule.md) -- [DiscordAutoModerationRuleTriggerMetadata](../interfaces/DiscordAutoModerationRuleTriggerMetadata.md) -- [DiscordBan](../interfaces/DiscordBan.md) -- [DiscordButtonComponent](../interfaces/DiscordButtonComponent.md) -- [DiscordChannel](../interfaces/DiscordChannel.md) -- [DiscordChannelMention](../interfaces/DiscordChannelMention.md) -- [DiscordChannelPinsUpdate](../interfaces/DiscordChannelPinsUpdate.md) -- [DiscordClientStatus](../interfaces/DiscordClientStatus.md) -- [DiscordCreateApplicationCommand](../interfaces/DiscordCreateApplicationCommand.md) -- [DiscordCreateForumPostWithMessage](../interfaces/DiscordCreateForumPostWithMessage.md) -- [DiscordCreateGuildChannel](../interfaces/DiscordCreateGuildChannel.md) -- [DiscordCreateGuildEmoji](../interfaces/DiscordCreateGuildEmoji.md) -- [DiscordCreateMessage](../interfaces/DiscordCreateMessage.md) -- [DiscordCreateWebhook](../interfaces/DiscordCreateWebhook.md) -- [DiscordDefaultReactionEmoji](../interfaces/DiscordDefaultReactionEmoji.md) -- [DiscordEditChannelPermissionOverridesOptions](../interfaces/DiscordEditChannelPermissionOverridesOptions.md) -- [DiscordEmbed](../interfaces/DiscordEmbed.md) -- [DiscordEmbedAuthor](../interfaces/DiscordEmbedAuthor.md) -- [DiscordEmbedField](../interfaces/DiscordEmbedField.md) -- [DiscordEmbedFooter](../interfaces/DiscordEmbedFooter.md) -- [DiscordEmbedImage](../interfaces/DiscordEmbedImage.md) -- [DiscordEmbedProvider](../interfaces/DiscordEmbedProvider.md) -- [DiscordEmbedThumbnail](../interfaces/DiscordEmbedThumbnail.md) -- [DiscordEmbedVideo](../interfaces/DiscordEmbedVideo.md) -- [DiscordEmoji](../interfaces/DiscordEmoji.md) -- [DiscordFollowAnnouncementChannel](../interfaces/DiscordFollowAnnouncementChannel.md) -- [DiscordFollowedChannel](../interfaces/DiscordFollowedChannel.md) -- [DiscordForumTag](../interfaces/DiscordForumTag.md) -- [DiscordGatewayPayload](../interfaces/DiscordGatewayPayload.md) -- [DiscordGetGatewayBot](../interfaces/DiscordGetGatewayBot.md) -- [DiscordGuild](../interfaces/DiscordGuild.md) -- [DiscordGuildApplicationCommandPermissions](../interfaces/DiscordGuildApplicationCommandPermissions.md) -- [DiscordGuildBanAddRemove](../interfaces/DiscordGuildBanAddRemove.md) -- [DiscordGuildEmojisUpdate](../interfaces/DiscordGuildEmojisUpdate.md) -- [DiscordGuildIntegrationsUpdate](../interfaces/DiscordGuildIntegrationsUpdate.md) -- [DiscordGuildMemberAdd](../interfaces/DiscordGuildMemberAdd.md) -- [DiscordGuildMemberRemove](../interfaces/DiscordGuildMemberRemove.md) -- [DiscordGuildMemberUpdate](../interfaces/DiscordGuildMemberUpdate.md) -- [DiscordGuildMembersChunk](../interfaces/DiscordGuildMembersChunk.md) -- [DiscordGuildPreview](../interfaces/DiscordGuildPreview.md) -- [DiscordGuildRoleCreate](../interfaces/DiscordGuildRoleCreate.md) -- [DiscordGuildRoleDelete](../interfaces/DiscordGuildRoleDelete.md) -- [DiscordGuildRoleUpdate](../interfaces/DiscordGuildRoleUpdate.md) -- [DiscordGuildStickersUpdate](../interfaces/DiscordGuildStickersUpdate.md) -- [DiscordGuildWidget](../interfaces/DiscordGuildWidget.md) -- [DiscordGuildWidgetSettings](../interfaces/DiscordGuildWidgetSettings.md) -- [DiscordHello](../interfaces/DiscordHello.md) -- [DiscordIncomingWebhook](../interfaces/DiscordIncomingWebhook.md) -- [DiscordInputTextComponent](../interfaces/DiscordInputTextComponent.md) -- [DiscordInstallParams](../interfaces/DiscordInstallParams.md) -- [DiscordIntegration](../interfaces/DiscordIntegration.md) -- [DiscordIntegrationAccount](../interfaces/DiscordIntegrationAccount.md) -- [DiscordIntegrationApplication](../interfaces/DiscordIntegrationApplication.md) -- [DiscordIntegrationCreateUpdate](../interfaces/DiscordIntegrationCreateUpdate.md) -- [DiscordIntegrationDelete](../interfaces/DiscordIntegrationDelete.md) -- [DiscordInteraction](../interfaces/DiscordInteraction.md) -- [DiscordInteractionData](../interfaces/DiscordInteractionData.md) -- [DiscordInteractionDataOption](../interfaces/DiscordInteractionDataOption.md) -- [DiscordInteractionMember](../interfaces/DiscordInteractionMember.md) -- [DiscordInvite](../interfaces/DiscordInvite.md) -- [DiscordInviteCreate](../interfaces/DiscordInviteCreate.md) -- [DiscordInviteDelete](../interfaces/DiscordInviteDelete.md) -- [DiscordInviteMetadata](../interfaces/DiscordInviteMetadata.md) -- [DiscordInviteStageInstance](../interfaces/DiscordInviteStageInstance.md) -- [DiscordListActiveThreads](../interfaces/DiscordListActiveThreads.md) -- [DiscordListArchivedThreads](../interfaces/DiscordListArchivedThreads.md) -- [DiscordMember](../interfaces/DiscordMember.md) -- [DiscordMemberWithUser](../interfaces/DiscordMemberWithUser.md) -- [DiscordMessage](../interfaces/DiscordMessage.md) -- [DiscordMessageActivity](../interfaces/DiscordMessageActivity.md) -- [DiscordMessageDelete](../interfaces/DiscordMessageDelete.md) -- [DiscordMessageDeleteBulk](../interfaces/DiscordMessageDeleteBulk.md) -- [DiscordMessageInteraction](../interfaces/DiscordMessageInteraction.md) -- [DiscordMessageReactionAdd](../interfaces/DiscordMessageReactionAdd.md) -- [DiscordMessageReactionRemove](../interfaces/DiscordMessageReactionRemove.md) -- [DiscordMessageReactionRemoveAll](../interfaces/DiscordMessageReactionRemoveAll.md) -- [DiscordMessageReference](../interfaces/DiscordMessageReference.md) -- [DiscordModifyChannel](../interfaces/DiscordModifyChannel.md) -- [DiscordModifyGuildChannelPositions](../interfaces/DiscordModifyGuildChannelPositions.md) -- [DiscordModifyGuildEmoji](../interfaces/DiscordModifyGuildEmoji.md) -- [DiscordModifyGuildWelcomeScreen](../interfaces/DiscordModifyGuildWelcomeScreen.md) -- [DiscordOptionalAuditEntryInfo](../interfaces/DiscordOptionalAuditEntryInfo.md) -- [DiscordOverwrite](../interfaces/DiscordOverwrite.md) -- [DiscordPresenceUpdate](../interfaces/DiscordPresenceUpdate.md) -- [DiscordPrunedCount](../interfaces/DiscordPrunedCount.md) -- [DiscordReaction](../interfaces/DiscordReaction.md) -- [DiscordReady](../interfaces/DiscordReady.md) -- [DiscordRole](../interfaces/DiscordRole.md) -- [DiscordRoleTags](../interfaces/DiscordRoleTags.md) -- [DiscordScheduledEvent](../interfaces/DiscordScheduledEvent.md) -- [DiscordScheduledEventEntityMetadata](../interfaces/DiscordScheduledEventEntityMetadata.md) -- [DiscordScheduledEventUserAdd](../interfaces/DiscordScheduledEventUserAdd.md) -- [DiscordScheduledEventUserRemove](../interfaces/DiscordScheduledEventUserRemove.md) -- [DiscordSelectMenuComponent](../interfaces/DiscordSelectMenuComponent.md) -- [DiscordSelectOption](../interfaces/DiscordSelectOption.md) -- [DiscordSessionStartLimit](../interfaces/DiscordSessionStartLimit.md) -- [DiscordStageInstance](../interfaces/DiscordStageInstance.md) -- [DiscordSticker](../interfaces/DiscordSticker.md) -- [DiscordStickerItem](../interfaces/DiscordStickerItem.md) -- [DiscordStickerPack](../interfaces/DiscordStickerPack.md) -- [DiscordTeam](../interfaces/DiscordTeam.md) -- [DiscordTeamMember](../interfaces/DiscordTeamMember.md) -- [DiscordTemplate](../interfaces/DiscordTemplate.md) -- [DiscordThreadListSync](../interfaces/DiscordThreadListSync.md) -- [DiscordThreadMember](../interfaces/DiscordThreadMember.md) -- [DiscordThreadMemberUpdate](../interfaces/DiscordThreadMemberUpdate.md) -- [DiscordThreadMembersUpdate](../interfaces/DiscordThreadMembersUpdate.md) -- [DiscordThreadMetadata](../interfaces/DiscordThreadMetadata.md) -- [DiscordTypingStart](../interfaces/DiscordTypingStart.md) -- [DiscordUnavailableGuild](../interfaces/DiscordUnavailableGuild.md) -- [DiscordUser](../interfaces/DiscordUser.md) -- [DiscordVanityUrl](../interfaces/DiscordVanityUrl.md) -- [DiscordVoiceRegion](../interfaces/DiscordVoiceRegion.md) -- [DiscordVoiceServerUpdate](../interfaces/DiscordVoiceServerUpdate.md) -- [DiscordVoiceState](../interfaces/DiscordVoiceState.md) -- [DiscordWebhookUpdate](../interfaces/DiscordWebhookUpdate.md) -- [DiscordWelcomeScreen](../interfaces/DiscordWelcomeScreen.md) -- [DiscordWelcomeScreenChannel](../interfaces/DiscordWelcomeScreenChannel.md) -- [EditAutoModerationRuleOptions](../interfaces/EditAutoModerationRuleOptions.md) -- [EditBotMemberOptions](../interfaces/EditBotMemberOptions.md) -- [EditChannelPermissionOverridesOptions](../interfaces/EditChannelPermissionOverridesOptions.md) -- [EditGuildRole](../interfaces/EditGuildRole.md) -- [EditGuildStickerOptions](../interfaces/EditGuildStickerOptions.md) -- [EditMessage](../interfaces/EditMessage.md) -- [EditOwnVoiceState](../interfaces/EditOwnVoiceState.md) -- [EditScheduledEvent](../interfaces/EditScheduledEvent.md) -- [EditStageInstanceOptions](../interfaces/EditStageInstanceOptions.md) -- [EditUserVoiceState](../interfaces/EditUserVoiceState.md) -- [ExecuteWebhook](../interfaces/ExecuteWebhook.md) -- [FileContent](../interfaces/FileContent.md) -- [GetBans](../interfaces/GetBans.md) -- [GetGuildAuditLog](../interfaces/GetGuildAuditLog.md) -- [GetGuildPruneCountQuery](../interfaces/GetGuildPruneCountQuery.md) -- [GetGuildWidgetImageQuery](../interfaces/GetGuildWidgetImageQuery.md) -- [GetInvite](../interfaces/GetInvite.md) -- [GetMessagesAfter](../interfaces/GetMessagesAfter.md) -- [GetMessagesAround](../interfaces/GetMessagesAround.md) -- [GetMessagesBefore](../interfaces/GetMessagesBefore.md) -- [GetMessagesLimit](../interfaces/GetMessagesLimit.md) -- [GetReactions](../interfaces/GetReactions.md) -- [GetScheduledEventUsers](../interfaces/GetScheduledEventUsers.md) -- [GetScheduledEvents](../interfaces/GetScheduledEvents.md) -- [GetWebhookMessageOptions](../interfaces/GetWebhookMessageOptions.md) -- [InputTextComponent](../interfaces/InputTextComponent.md) -- [InteractionCallbackData](../interfaces/InteractionCallbackData.md) -- [InteractionResponse](../interfaces/InteractionResponse.md) -- [ListArchivedThreads](../interfaces/ListArchivedThreads.md) -- [ListGuildMembers](../interfaces/ListGuildMembers.md) -- [ModifyChannel](../interfaces/ModifyChannel.md) -- [ModifyGuild](../interfaces/ModifyGuild.md) -- [ModifyGuildChannelPositions](../interfaces/ModifyGuildChannelPositions.md) -- [ModifyGuildEmoji](../interfaces/ModifyGuildEmoji.md) -- [ModifyGuildMember](../interfaces/ModifyGuildMember.md) -- [ModifyGuildTemplate](../interfaces/ModifyGuildTemplate.md) -- [ModifyRolePositions](../interfaces/ModifyRolePositions.md) -- [ModifyWebhook](../interfaces/ModifyWebhook.md) -- [OverwriteReadable](../interfaces/OverwriteReadable.md) -- [RequestGuildMembers](../interfaces/RequestGuildMembers.md) -- [SearchMembers](../interfaces/SearchMembers.md) -- [SelectMenuChannelsComponent](../interfaces/SelectMenuChannelsComponent.md) -- [SelectMenuComponent](../interfaces/SelectMenuComponent.md) -- [SelectMenuRolesComponent](../interfaces/SelectMenuRolesComponent.md) -- [SelectMenuUsersAndRolesComponent](../interfaces/SelectMenuUsersAndRolesComponent.md) -- [SelectMenuUsersComponent](../interfaces/SelectMenuUsersComponent.md) -- [SelectOption](../interfaces/SelectOption.md) -- [StartThreadWithMessage](../interfaces/StartThreadWithMessage.md) -- [StartThreadWithoutMessage](../interfaces/StartThreadWithoutMessage.md) -- [WithReason](../interfaces/WithReason.md) - -### Type Aliases - -- [AtLeastOne](md#atleastone) -- [BigString](md#bigstring) -- [CamelCase](md#camelcase) -- [Camelize](md#camelize) -- [CreateApplicationCommand](md#createapplicationcommand) -- [DiscordArchivedThreads](md#discordarchivedthreads) -- [DiscordAuditLogChange](md#discordauditlogchange) -- [DiscordMessageComponents](md#discordmessagecomponents) -- [DiscordMessageReactionRemoveEmoji](md#discordmessagereactionremoveemoji) -- [DiscordWebhook](md#discordwebhook) -- [EmbedTypes](md#embedtypes) -- [GatewayDispatchEventNames](md#gatewaydispatcheventnames) -- [GatewayEventNames](md#gatewayeventnames) -- [GetMessagesOptions](md#getmessagesoptions) -- [ImageFormat](md#imageformat) -- [ImageSize](md#imagesize) -- [Localization](md#localization) -- [MessageComponents](md#messagecomponents) -- [PermissionStrings](md#permissionstrings) -- [PickPartial](md#pickpartial) -- [SnakeCase](md#snakecase) -- [Snakelize](md#snakelize) - -### Variables - -- [Intents](md#intents) - -## Type Aliases - -### AtLeastOne - -Ƭ **AtLeastOne**<`T`, `U`\>: `Partial`<`T`\> & `U`[keyof `U`] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `U` | { [K in keyof T]: Pick } | - -#### Defined in - -[packages/types/src/shared.ts:945](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L945) - -___ - -### BigString - -Ƭ **BigString**: `bigint` \| `string` - -#### Defined in - -[packages/types/src/shared.ts:1](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L1) - -___ - -### CamelCase - -Ƭ **CamelCase**<`S`\>: `S` extends \`${infer T}\_${infer U}\` ? \`${T}${Capitalize\>}\` : `S` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `string` | - -#### Defined in - -[packages/types/src/shared.ts:946](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L946) - -___ - -### Camelize - -Ƭ **Camelize**<`T`\>: `T` extends `any`[] ? `T` extends `Record`<`any`, `any`\>[] ? [`Camelize`](md#camelize)<`T`[`number`]\>[] : `T` : `T` extends `Record`<`any`, `any`\> ? { [K in keyof T as CamelCase]: Camelize } : `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[packages/types/src/shared.ts:949](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L949) - -___ - -### CreateApplicationCommand - -Ƭ **CreateApplicationCommand**: [`CreateSlashApplicationCommand`](../interfaces/CreateSlashApplicationCommand.md) \| [`CreateContextApplicationCommand`](../interfaces/CreateContextApplicationCommand.md) - -#### Defined in - -[packages/types/src/discordeno.ts:386](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/discordeno.ts#L386) - -___ - -### DiscordArchivedThreads - -Ƭ **DiscordArchivedThreads**: [`DiscordActiveThreads`](../interfaces/DiscordActiveThreads.md) & { `hasMore`: `boolean` } - -#### Defined in - -[packages/types/src/discord.ts:2569](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/discord.ts#L2569) - -___ - -### DiscordAuditLogChange - -Ƭ **DiscordAuditLogChange**: { `key`: ``"name"`` \| ``"description"`` \| ``"discovery_splash_hash"`` \| ``"banner_hash"`` \| ``"preferred_locale"`` \| ``"rules_channel_id"`` \| ``"public_updates_channel_id"`` \| ``"icon_hash"`` \| ``"image_hash"`` \| ``"splash_hash"`` \| ``"owner_id"`` \| ``"region"`` \| ``"afk_channel_id"`` \| ``"vanity_url_code"`` \| ``"widget_channel_id"`` \| ``"system_channel_id"`` \| ``"topic"`` \| ``"application_id"`` \| ``"permissions"`` \| ``"allow"`` \| ``"deny"`` \| ``"code"`` \| ``"channel_id"`` \| ``"inviter_id"`` \| ``"nick"`` \| ``"avatar_hash"`` \| ``"id"`` \| ``"location"`` \| ``"command_id"`` ; `new_value`: `string` ; `old_value`: `string` } \| { `key`: ``"afk_timeout"`` \| ``"mfa_level"`` \| ``"verification_level"`` \| ``"explicit_content_filter"`` \| ``"default_message_notifications"`` \| ``"prune_delete_days"`` \| ``"position"`` \| ``"bitrate"`` \| ``"rate_limit_per_user"`` \| ``"color"`` \| ``"max_uses"`` \| ``"uses"`` \| ``"max_age"`` \| ``"expire_behavior"`` \| ``"expire_grace_period"`` \| ``"user_limit"`` \| ``"privacy_level"`` \| ``"auto_archive_duration"`` \| ``"default_auto_archive_duration"`` \| ``"entity_type"`` \| ``"status"`` \| ``"communication_disabled_until"`` ; `new_value`: `number` ; `old_value`: `number` } \| { `key`: ``"$add"`` \| ``"$remove"`` ; `new_value`: `Partial`<[`DiscordRole`](../interfaces/DiscordRole.md)\>[] ; `old_value?`: `Partial`<[`DiscordRole`](../interfaces/DiscordRole.md)\>[] } \| { `key`: ``"widget_enabled"`` \| ``"nsfw"`` \| ``"hoist"`` \| ``"mentionable"`` \| ``"temporary"`` \| ``"deaf"`` \| ``"mute"`` \| ``"enable_emoticons"`` \| ``"archived"`` \| ``"locked"`` \| ``"invitable"`` ; `new_value`: `boolean` ; `old_value`: `boolean` } \| { `key`: ``"permission_overwrites"`` ; `new_value`: [`DiscordOverwrite`](../interfaces/DiscordOverwrite.md)[] ; `old_value`: [`DiscordOverwrite`](../interfaces/DiscordOverwrite.md)[] } \| { `key`: ``"type"`` ; `new_value`: `string` \| `number` ; `old_value`: `string` \| `number` } - -https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure - -#### Defined in - -[packages/types/src/discord.ts:1495](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/discord.ts#L1495) - -___ - -### DiscordMessageComponents - -Ƭ **DiscordMessageComponents**: [`DiscordActionRow`](../interfaces/DiscordActionRow.md)[] - -#### Defined in - -[packages/types/src/discord.ts:1110](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/discord.ts#L1110) - -___ - -### DiscordMessageReactionRemoveEmoji - -Ƭ **DiscordMessageReactionRemoveEmoji**: `Pick`<[`DiscordMessageReactionAdd`](../interfaces/DiscordMessageReactionAdd.md), ``"channel_id"`` \| ``"guild_id"`` \| ``"message_id"`` \| ``"emoji"``\> - -https://discord.com/developers/docs/topics/gateway#message-reaction-remove-emoji - -#### Defined in - -[packages/types/src/discord.ts:2251](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/discord.ts#L2251) - -___ - -### DiscordWebhook - -Ƭ **DiscordWebhook**: [`DiscordIncomingWebhook`](../interfaces/DiscordIncomingWebhook.md) \| [`DiscordApplicationWebhook`](../interfaces/DiscordApplicationWebhook.md) - -https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-structure - -#### Defined in - -[packages/types/src/discord.ts:422](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/discord.ts#L422) - -___ - -### EmbedTypes - -Ƭ **EmbedTypes**: ``"rich"`` \| ``"image"`` \| ``"video"`` \| ``"gifv"`` \| ``"article"`` \| ``"link"`` - -https://discord.com/developers/docs/resources/channel#embed-object-embed-types - -#### Defined in - -[packages/types/src/shared.ts:142](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L142) - -___ - -### GatewayDispatchEventNames - -Ƭ **GatewayDispatchEventNames**: ``"READY"`` \| ``"APPLICATION_COMMAND_PERMISSIONS_UPDATE"`` \| ``"AUTO_MODERATION_RULE_CREATE"`` \| ``"AUTO_MODERATION_RULE_UPDATE"`` \| ``"AUTO_MODERATION_RULE_DELETE"`` \| ``"AUTO_MODERATION_ACTION_EXECUTION"`` \| ``"CHANNEL_CREATE"`` \| ``"CHANNEL_UPDATE"`` \| ``"CHANNEL_DELETE"`` \| ``"CHANNEL_PINS_UPDATE"`` \| ``"THREAD_CREATE"`` \| ``"THREAD_UPDATE"`` \| ``"THREAD_DELETE"`` \| ``"THREAD_LIST_SYNC"`` \| ``"THREAD_MEMBER_UPDATE"`` \| ``"THREAD_MEMBERS_UPDATE"`` \| ``"GUILD_CREATE"`` \| ``"GUILD_UPDATE"`` \| ``"GUILD_DELETE"`` \| ``"GUILD_BAN_ADD"`` \| ``"GUILD_BAN_REMOVE"`` \| ``"GUILD_EMOJIS_UPDATE"`` \| ``"GUILD_STICKERS_UPDATE"`` \| ``"GUILD_INTEGRATIONS_UPDATE"`` \| ``"GUILD_MEMBER_ADD"`` \| ``"GUILD_MEMBER_REMOVE"`` \| ``"GUILD_MEMBER_UPDATE"`` \| ``"GUILD_MEMBERS_CHUNK"`` \| ``"GUILD_ROLE_CREATE"`` \| ``"GUILD_ROLE_UPDATE"`` \| ``"GUILD_ROLE_DELETE"`` \| ``"GUILD_SCHEDULED_EVENT_CREATE"`` \| ``"GUILD_SCHEDULED_EVENT_UPDATE"`` \| ``"GUILD_SCHEDULED_EVENT_DELETE"`` \| ``"GUILD_SCHEDULED_EVENT_USER_ADD"`` \| ``"GUILD_SCHEDULED_EVENT_USER_REMOVE"`` \| ``"INTEGRATION_CREATE"`` \| ``"INTEGRATION_UPDATE"`` \| ``"INTEGRATION_DELETE"`` \| ``"INTERACTION_CREATE"`` \| ``"INVITE_CREATE"`` \| ``"INVITE_DELETE"`` \| ``"MESSAGE_CREATE"`` \| ``"MESSAGE_UPDATE"`` \| ``"MESSAGE_DELETE"`` \| ``"MESSAGE_DELETE_BULK"`` \| ``"MESSAGE_REACTION_ADD"`` \| ``"MESSAGE_REACTION_REMOVE"`` \| ``"MESSAGE_REACTION_REMOVE_ALL"`` \| ``"MESSAGE_REACTION_REMOVE_EMOJI"`` \| ``"PRESENCE_UPDATE"`` \| ``"STAGE_INSTANCE_CREATE"`` \| ``"STAGE_INSTANCE_UPDATE"`` \| ``"STAGE_INSTANCE_DELETE"`` \| ``"TYPING_START"`` \| ``"USER_UPDATE"`` \| ``"VOICE_STATE_UPDATE"`` \| ``"VOICE_SERVER_UPDATE"`` \| ``"WEBHOOKS_UPDATE"`` - -#### Defined in - -[packages/types/src/shared.ts:686](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L686) - -___ - -### GatewayEventNames - -Ƭ **GatewayEventNames**: [`GatewayDispatchEventNames`](md#gatewaydispatcheventnames) \| ``"READY"`` \| ``"RESUMED"`` - -#### Defined in - -[packages/types/src/shared.ts:747](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L747) - -___ - -### GetMessagesOptions - -Ƭ **GetMessagesOptions**: [`GetMessagesAfter`](../interfaces/GetMessagesAfter.md) \| [`GetMessagesBefore`](../interfaces/GetMessagesBefore.md) \| [`GetMessagesAround`](../interfaces/GetMessagesAround.md) \| [`GetMessagesLimit`](../interfaces/GetMessagesLimit.md) - -#### Defined in - -[packages/types/src/discordeno.ts:310](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/discordeno.ts#L310) - -___ - -### ImageFormat - -Ƭ **ImageFormat**: ``"jpg"`` \| ``"jpeg"`` \| ``"png"`` \| ``"webp"`` \| ``"gif"`` \| ``"json"`` - -https://discord.com/developers/docs/reference#image-formatting -json is only for stickers - -#### Defined in - -[packages/types/src/shared.ts:905](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L905) - -___ - -### ImageSize - -Ƭ **ImageSize**: ``16`` \| ``32`` \| ``64`` \| ``128`` \| ``256`` \| ``512`` \| ``1024`` \| ``2048`` \| ``4096`` - -https://discord.com/developers/docs/reference#image-formatting - -#### Defined in - -[packages/types/src/shared.ts:908](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L908) - -___ - -### Localization - -Ƭ **Localization**: `Partial`<`Record`<[`Locales`](../enums/Locales.md), `string`\>\> - -#### Defined in - -[packages/types/src/shared.ts:943](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L943) - -___ - -### MessageComponents - -Ƭ **MessageComponents**: [`ActionRow`](../interfaces/ActionRow.md)[] - -#### Defined in - -[packages/types/src/discordeno.ts:73](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/discordeno.ts#L73) - -___ - -### PermissionStrings - -Ƭ **PermissionStrings**: keyof typeof [`BitwisePermissionFlags`](../enums/BitwisePermissionFlags.md) - -#### Defined in - -[packages/types/src/shared.ts:624](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L624) - -___ - -### PickPartial - -Ƭ **PickPartial**<`T`, `K`\>: { [P in keyof T]?: T[P] } & { [P in K]: T[P] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `T` | - -#### Defined in - -[packages/types/src/shared.ts:965](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L965) - -___ - -### SnakeCase - -Ƭ **SnakeCase**<`S`\>: `S` extends \`${infer T}${infer U}\` ? \`${T extends Capitalize ? "\_" : ""}${Lowercase}${SnakeCase}\` : `S` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `string` | - -#### Defined in - -[packages/types/src/shared.ts:947](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L947) - -___ - -### Snakelize - -Ƭ **Snakelize**<`T`\>: `T` extends `any`[] ? `T` extends `Record`<`any`, `any`\>[] ? [`Snakelize`](md#snakelize)<`T`[`number`]\>[] : `T` : `T` extends `Record`<`any`, `any`\> ? { [K in keyof T as SnakeCase]: Snakelize } : `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[packages/types/src/shared.ts:957](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L957) - -## Variables - -### Intents - -• `Const` **Intents**: typeof [`GatewayIntents`](../enums/GatewayIntents.md) = `GatewayIntents` - -https://discord.com/developers/docs/topics/gateway#list-of-intents - -#### Defined in - -[packages/types/src/shared.ts:874](https://github.com/discordeno/discordeno/blob/b8c25357/packages/types/src/shared.ts#L874) diff --git a/website/docs/generated/modules_utils.md b/website/docs/generated/modules_utils.md deleted file mode 100644 index 444ae83de..000000000 --- a/website/docs/generated/modules_utils.md +++ /dev/null @@ -1,2000 +0,0 @@ -[discordeno-monorepo](../README.md) / [Modules](../modules.md) / @discordeno/utils - -# Module: @discordeno/utils - -## Table of contents - -### Enumerations - -- [LogDepth](../enums/LogDepth.md) -- [LogLevels](../enums/LogLevels.md) - -### Classes - -- [Collection](../classes/Collection.md) - -### Interfaces - -- [Code](../interfaces/Code.md) -- [CollectionOptions](../interfaces/CollectionOptions.md) -- [CollectionSweeper](../interfaces/CollectionSweeper.md) -- [LeakyBucket](../interfaces/LeakyBucket.md) -- [PlaceHolderBot](../interfaces/PlaceHolderBot.md) -- [Rgb](../interfaces/Rgb.md) - -### Variables - -- [logger](md#logger) - -### Functions - -- [acquire](md#acquire) -- [avatarUrl](md#avatarurl) -- [bgBlack](md#bgblack) -- [bgBlue](md#bgblue) -- [bgBrightBlack](md#bgbrightblack) -- [bgBrightBlue](md#bgbrightblue) -- [bgBrightCyan](md#bgbrightcyan) -- [bgBrightGreen](md#bgbrightgreen) -- [bgBrightMagenta](md#bgbrightmagenta) -- [bgBrightRed](md#bgbrightred) -- [bgBrightWhite](md#bgbrightwhite) -- [bgBrightYellow](md#bgbrightyellow) -- [bgCyan](md#bgcyan) -- [bgGreen](md#bggreen) -- [bgMagenta](md#bgmagenta) -- [bgRed](md#bgred) -- [bgRgb24](md#bgrgb24) -- [bgRgb8](md#bgrgb8) -- [bgWhite](md#bgwhite) -- [bgYellow](md#bgyellow) -- [black](md#black) -- [blue](md#blue) -- [bold](md#bold) -- [brightBlack](md#brightblack) -- [brightBlue](md#brightblue) -- [brightCyan](md#brightcyan) -- [brightGreen](md#brightgreen) -- [brightMagenta](md#brightmagenta) -- [brightRed](md#brightred) -- [brightWhite](md#brightwhite) -- [brightYellow](md#brightyellow) -- [calculateBits](md#calculatebits) -- [calculatePermissions](md#calculatepermissions) -- [camelToSnakeCase](md#cameltosnakecase) -- [camelize](md#camelize) -- [coerceToFileContent](md#coercetofilecontent) -- [createLeakyBucket](md#createleakybucket) -- [createLogger](md#createlogger) -- [cyan](md#cyan) -- [decode](md#decode) -- [delay](md#delay) -- [dim](md#dim) -- [emojiUrl](md#emojiurl) -- [encode](md#encode) -- [findFiles](md#findfiles) -- [formatImageUrl](md#formatimageurl) -- [getBotIdFromToken](md#getbotidfromtoken) -- [getColorEnabled](md#getcolorenabled) -- [getWidgetImageUrl](md#getwidgetimageurl) -- [gray](md#gray) -- [green](md#green) -- [guildBannerUrl](md#guildbannerurl) -- [guildIconUrl](md#guildiconurl) -- [guildSplashUrl](md#guildsplashurl) -- [hasProperty](md#hasproperty) -- [hidden](md#hidden) -- [iconBigintToHash](md#iconbiginttohash) -- [iconHashToBigInt](md#iconhashtobigint) -- [inverse](md#inverse) -- [isGetMessagesAfter](md#isgetmessagesafter) -- [isGetMessagesAround](md#isgetmessagesaround) -- [isGetMessagesBefore](md#isgetmessagesbefore) -- [isGetMessagesLimit](md#isgetmessageslimit) -- [italic](md#italic) -- [magenta](md#magenta) -- [nextRefill](md#nextrefill) -- [processReactionString](md#processreactionstring) -- [red](md#red) -- [removeTokenPrefix](md#removetokenprefix) -- [reset](md#reset) -- [rgb24](md#rgb24) -- [rgb8](md#rgb8) -- [setColorEnabled](md#setcolorenabled) -- [snakeToCamelCase](md#snaketocamelcase) -- [snakelize](md#snakelize) -- [strikethrough](md#strikethrough) -- [stripColor](md#stripcolor) -- [underline](md#underline) -- [updateTokens](md#updatetokens) -- [urlToBase64](md#urltobase64) -- [white](md#white) -- [yellow](md#yellow) - -## Variables - -### logger - -• `Const` **logger**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `debug` | (...`args`: `any`[]) => `void` | -| `error` | (...`args`: `any`[]) => `void` | -| `fatal` | (...`args`: `any`[]) => `void` | -| `info` | (...`args`: `any`[]) => `void` | -| `log` | (`level`: [`LogLevels`](../enums/LogLevels.md), ...`args`: `any`[]) => `void` | -| `setDepth` | (`level`: [`LogDepth`](../enums/LogDepth.md)) => `void` | -| `setLevel` | (`level`: [`LogLevels`](../enums/LogLevels.md)) => `void` | -| `warn` | (...`args`: `any`[]) => `void` | - -#### Defined in - -[packages/utils/src/logger.ts:118](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/logger.ts#L118) - -## Functions - -### acquire - -▸ **acquire**(`bucket`, `amount`, `highPriority?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `bucket` | [`LeakyBucket`](../interfaces/LeakyBucket.md) | `undefined` | -| `amount` | `number` | `undefined` | -| `highPriority` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/utils/src/bucket.ts:113](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/bucket.ts#L113) - -___ - -### avatarUrl - -▸ **avatarUrl**(`userId`, `discriminator`, `options?`): `string` - -Builds a URL to a user's avatar stored in the Discord CDN. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userId` | `BigString` | The ID of the user to get the avatar of. | -| `discriminator` | `string` | The user's discriminator. (4-digit tag after the hashtag.) | -| `options?` | `Object` | The parameters for the building of the URL. | -| `options.avatar` | `undefined` \| `BigString` | - | -| `options.format?` | `ImageFormat` | - | -| `options.size?` | `ImageSize` | - | - -#### Returns - -`string` - -The link to the resource. - -#### Defined in - -[packages/utils/src/images.ts:29](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/images.ts#L29) - -___ - -### bgBlack - -▸ **bgBlack**(`str`): `string` - -Set background color to black. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background black | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:268](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L268) - -___ - -### bgBlue - -▸ **bgBlue**(`str`): `string` - -Set background color to blue. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background blue | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:300](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L300) - -___ - -### bgBrightBlack - -▸ **bgBrightBlack**(`str`): `string` - -Set background color to bright black. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-black | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:332](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L332) - -___ - -### bgBrightBlue - -▸ **bgBrightBlue**(`str`): `string` - -Set background color to bright blue. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-blue | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:364](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L364) - -___ - -### bgBrightCyan - -▸ **bgBrightCyan**(`str`): `string` - -Set background color to bright cyan. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-cyan | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:380](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L380) - -___ - -### bgBrightGreen - -▸ **bgBrightGreen**(`str`): `string` - -Set background color to bright green. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-green | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:348](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L348) - -___ - -### bgBrightMagenta - -▸ **bgBrightMagenta**(`str`): `string` - -Set background color to bright magenta. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-magenta | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:372](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L372) - -___ - -### bgBrightRed - -▸ **bgBrightRed**(`str`): `string` - -Set background color to bright red. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-red | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:340](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L340) - -___ - -### bgBrightWhite - -▸ **bgBrightWhite**(`str`): `string` - -Set background color to bright white. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-white | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:388](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L388) - -___ - -### bgBrightYellow - -▸ **bgBrightYellow**(`str`): `string` - -Set background color to bright yellow. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background bright-yellow | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:356](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L356) - -___ - -### bgCyan - -▸ **bgCyan**(`str`): `string` - -Set background color to cyan. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background cyan | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:316](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L316) - -___ - -### bgGreen - -▸ **bgGreen**(`str`): `string` - -Set background color to green. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background green | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:284](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L284) - -___ - -### bgMagenta - -▸ **bgMagenta**(`str`): `string` - -Set background color to magenta. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background magenta | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:308](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L308) - -___ - -### bgRed - -▸ **bgRed**(`str`): `string` - -Set background color to red. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background red | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:276](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L276) - -___ - -### bgRgb24 - -▸ **bgRgb24**(`str`, `color`): `string` - -Set background color using 24bit rgb. -`color` can be a number in range `0x000000` to `0xffffff` or -an `Rgb`. - -To produce the color magenta: - -```ts - import { bgRgb24 } from "./colors.ts"; - bgRgb24("foo", 0xff00ff); - bgRgb24("foo", {r: 255, g: 0, b: 255}); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text color to apply 24bit rgb to | -| `color` | `number` \| [`Rgb`](../interfaces/Rgb.md) | code | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:461](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L461) - -___ - -### bgRgb8 - -▸ **bgRgb8**(`str`, `color`): `string` - -Set background color using paletted 8bit colors. -https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text color to apply paletted 8bit background colors to | -| `color` | `number` | code | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:420](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L420) - -___ - -### bgWhite - -▸ **bgWhite**(`str`): `string` - -Set background color to white. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background white | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:324](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L324) - -___ - -### bgYellow - -▸ **bgYellow**(`str`): `string` - -Set background color to yellow. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make its background yellow | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:292](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L292) - -___ - -### black - -▸ **black**(`str`): `string` - -Set text color to black. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make black | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:132](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L132) - -___ - -### blue - -▸ **blue**(`str`): `string` - -Set text color to blue. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make blue | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:164](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L164) - -___ - -### bold - -▸ **bold**(`str`): `string` - -Make the text bold. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bold | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:76](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L76) - -___ - -### brightBlack - -▸ **brightBlack**(`str`): `string` - -Set text color to bright black. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-black | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:204](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L204) - -___ - -### brightBlue - -▸ **brightBlue**(`str`): `string` - -Set text color to bright blue. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-blue | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:236](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L236) - -___ - -### brightCyan - -▸ **brightCyan**(`str`): `string` - -Set text color to bright cyan. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-cyan | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:252](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L252) - -___ - -### brightGreen - -▸ **brightGreen**(`str`): `string` - -Set text color to bright green. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-green | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:220](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L220) - -___ - -### brightMagenta - -▸ **brightMagenta**(`str`): `string` - -Set text color to bright magenta. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-magenta | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:244](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L244) - -___ - -### brightRed - -▸ **brightRed**(`str`): `string` - -Set text color to bright red. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-red | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:212](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L212) - -___ - -### brightWhite - -▸ **brightWhite**(`str`): `string` - -Set text color to bright white. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-white | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:260](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L260) - -___ - -### brightYellow - -▸ **brightYellow**(`str`): `string` - -Set text color to bright yellow. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make bright-yellow | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:228](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L228) - -___ - -### calculateBits - -▸ **calculateBits**(`permissions`): `string` - -This function converts an array of permissions into the bitwise string. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `permissions` | (``"CREATE_INSTANT_INVITE"`` \| ``"KICK_MEMBERS"`` \| ``"BAN_MEMBERS"`` \| ``"ADMINISTRATOR"`` \| ``"MANAGE_CHANNELS"`` \| ``"MANAGE_GUILD"`` \| ``"ADD_REACTIONS"`` \| ``"VIEW_AUDIT_LOG"`` \| ``"PRIORITY_SPEAKER"`` \| ``"STREAM"`` \| ``"VIEW_CHANNEL"`` \| ``"SEND_MESSAGES"`` \| ``"SEND_TTS_MESSAGES"`` \| ``"MANAGE_MESSAGES"`` \| ``"EMBED_LINKS"`` \| ``"ATTACH_FILES"`` \| ``"READ_MESSAGE_HISTORY"`` \| ``"MENTION_EVERYONE"`` \| ``"USE_EXTERNAL_EMOJIS"`` \| ``"VIEW_GUILD_INSIGHTS"`` \| ``"CONNECT"`` \| ``"SPEAK"`` \| ``"MUTE_MEMBERS"`` \| ``"DEAFEN_MEMBERS"`` \| ``"MOVE_MEMBERS"`` \| ``"USE_VAD"`` \| ``"CHANGE_NICKNAME"`` \| ``"MANAGE_NICKNAMES"`` \| ``"MANAGE_ROLES"`` \| ``"MANAGE_WEBHOOKS"`` \| ``"MANAGE_EMOJIS_AND_STICKERS"`` \| ``"USE_SLASH_COMMANDS"`` \| ``"REQUEST_TO_SPEAK"`` \| ``"MANAGE_EVENTS"`` \| ``"MANAGE_THREADS"`` \| ``"CREATE_PUBLIC_THREADS"`` \| ``"CREATE_PRIVATE_THREADS"`` \| ``"USE_EXTERNAL_STICKERS"`` \| ``"SEND_MESSAGES_IN_THREADS"`` \| ``"USE_EMBEDDED_ACTIVITIES"`` \| ``"MODERATE_MEMBERS"``)[] | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/permissions.ts:15](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/permissions.ts#L15) - -___ - -### calculatePermissions - -▸ **calculatePermissions**(`permissionBits`): `PermissionStrings`[] - -This function converts a bitwise string to permission strings - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `permissionBits` | `bigint` | - -#### Returns - -`PermissionStrings`[] - -#### Defined in - -[packages/utils/src/permissions.ts:5](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/permissions.ts#L5) - -___ - -### camelToSnakeCase - -▸ **camelToSnakeCase**(`str`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `str` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/casing.ts:53](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/casing.ts#L53) - -___ - -### camelize - -▸ **camelize**<`T`\>(`object`): `Camelize`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `T` | - -#### Returns - -`Camelize`<`T`\> - -#### Defined in - -[packages/utils/src/casing.ts:3](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/casing.ts#L3) - -___ - -### coerceToFileContent - -▸ **coerceToFileContent**(`value`): value is FileContent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `unknown` | - -#### Returns - -value is FileContent - -#### Defined in - -[packages/utils/src/files.ts:13](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/files.ts#L13) - -___ - -### createLeakyBucket - -▸ **createLeakyBucket**(`«destructured»`): [`LeakyBucket`](../interfaces/LeakyBucket.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `«destructured»` | `Omit`<`PickPartial`<[`LeakyBucket`](../interfaces/LeakyBucket.md), ``"max"`` \| ``"refillInterval"`` \| ``"refillAmount"``\>, ``"tokens"``\> & { `tokens?`: `number` } | - -#### Returns - -[`LeakyBucket`](../interfaces/LeakyBucket.md) - -#### Defined in - -[packages/utils/src/bucket.ts:53](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/bucket.ts#L53) - -___ - -### createLogger - -▸ **createLogger**(`«destructured»?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `«destructured»` | `Object` | -| › `logLevel?` | [`LogLevels`](../enums/LogLevels.md) | -| › `name?` | `string` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `debug` | (...`args`: `any`[]) => `void` | -| `error` | (...`args`: `any`[]) => `void` | -| `fatal` | (...`args`: `any`[]) => `void` | -| `info` | (...`args`: `any`[]) => `void` | -| `log` | (`level`: [`LogLevels`](../enums/LogLevels.md), ...`args`: `any`[]) => `void` | -| `setDepth` | (`level`: [`LogDepth`](../enums/LogDepth.md)) => `void` | -| `setLevel` | (`level`: [`LogLevels`](../enums/LogLevels.md)) => `void` | -| `warn` | (...`args`: `any`[]) => `void` | - -#### Defined in - -[packages/utils/src/logger.ts:34](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/logger.ts#L34) - -___ - -### cyan - -▸ **cyan**(`str`): `string` - -Set text color to cyan. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make cyan | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:180](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L180) - -___ - -### decode - -▸ **decode**(`data`): `Uint8Array` - -CREDIT: https://gist.github.com/enepomnyaschih/72c423f727d395eeaa09697058238727 -Decodes RFC4648 base64 string into an Uint8Array - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/utils/src/base64.ts:38](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/base64.ts#L38) - -___ - -### delay - -▸ **delay**(`ms`): `Promise`<`void`\> - -Pause the execution for a given amount of milliseconds. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ms` | `number` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/utils/src/utils.ts:2](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/utils.ts#L2) - -___ - -### dim - -▸ **dim**(`str`): `string` - -The text emits only a small amount of light. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to dim | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:84](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L84) - -___ - -### emojiUrl - -▸ **emojiUrl**(`emojiId`, `animated?`): `string` - -Get the url for an emoji. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `emojiId` | `BigString` | `undefined` | The id of the emoji | -| `animated` | `boolean` | `false` | Whether or not the emoji is animated | - -#### Returns - -`string` - -string - -#### Defined in - -[packages/utils/src/images.ts:17](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/images.ts#L17) - -___ - -### encode - -▸ **encode**(`data`): `string` - -CREDIT: https://gist.github.com/enepomnyaschih/72c423f727d395eeaa09697058238727 -Encodes a given Uint8Array, ArrayBuffer or string into RFC4648 base64 representation - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` \| `ArrayBuffer` | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/base64.ts:6](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/base64.ts#L6) - -___ - -### findFiles - -▸ **findFiles**(`file`): `FileContent`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `file` | `unknown` | - -#### Returns - -`FileContent`[] - -#### Defined in - -[packages/utils/src/files.ts:4](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/files.ts#L4) - -___ - -### formatImageUrl - -▸ **formatImageUrl**(`url`, `size?`, `format?`): `string` - -Help format an image url. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `url` | `string` | `undefined` | -| `size` | `ImageSize` | `128` | -| `format?` | `ImageFormat` | `undefined` | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/images.ts:6](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/images.ts#L6) - -___ - -### getBotIdFromToken - -▸ **getBotIdFromToken**(`token`): `bigint` - -Get the bot id from the bot token. WARNING: Discord staff has mentioned this may not be stable forever. Use at your own risk. However, note for over 5 years this has never broken. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `token` | `string` | - -#### Returns - -`bigint` - -#### Defined in - -[packages/utils/src/token.ts:16](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/token.ts#L16) - -___ - -### getColorEnabled - -▸ **getColorEnabled**(): `boolean` - -Get whether text color change is enabled or disabled. - -#### Returns - -`boolean` - -#### Defined in - -[packages/utils/src/colors.ts:38](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L38) - -___ - -### getWidgetImageUrl - -▸ **getWidgetImageUrl**(`guildId`, `options?`): `string` - -Builds a URL to the guild widget image stored in the Discord CDN. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guildId` | `BigString` | The ID of the guild to get the link to the widget image for. | -| `options?` | `GetGuildWidgetImageQuery` | The parameters for the building of the URL. | - -#### Returns - -`string` - -The link to the resource. - -#### Defined in - -[packages/utils/src/images.ts:127](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/images.ts#L127) - -___ - -### gray - -▸ **gray**(`str`): `string` - -Set text color to gray. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make gray | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:196](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L196) - -___ - -### green - -▸ **green**(`str`): `string` - -Set text color to green. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make green | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:148](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L148) - -___ - -### guildBannerUrl - -▸ **guildBannerUrl**(`guildId`, `options`): `string` \| `undefined` - -Builds a URL to the guild banner stored in the Discord CDN. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guildId` | `BigString` | The ID of the guild to get the link to the banner for. | -| `options` | `Object` | The parameters for the building of the URL. | -| `options.banner?` | `string` \| `bigint` | - | -| `options.format?` | `ImageFormat` | - | -| `options.size?` | `ImageSize` | - | - -#### Returns - -`string` \| `undefined` - -The link to the resource or `undefined` if no banner has been set. - -#### Defined in - -[packages/utils/src/images.ts:54](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/images.ts#L54) - -___ - -### guildIconUrl - -▸ **guildIconUrl**(`guildId`, `imageHash`, `options?`): `string` \| `undefined` - -Builds a URL to the guild icon stored in the Discord CDN. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guildId` | `BigString` | The ID of the guild to get the link to the banner for. | -| `imageHash` | `undefined` \| `BigString` | - | -| `options?` | `Object` | The parameters for the building of the URL. | -| `options.format?` | `ImageFormat` | - | -| `options.size?` | `ImageSize` | - | - -#### Returns - -`string` \| `undefined` - -The link to the resource or `undefined` if no banner has been set. - -#### Defined in - -[packages/utils/src/images.ts:78](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/images.ts#L78) - -___ - -### guildSplashUrl - -▸ **guildSplashUrl**(`guildId`, `imageHash`, `options?`): `string` \| `undefined` - -Builds the URL to a guild splash stored in the Discord CDN. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guildId` | `BigString` | The ID of the guild to get the splash of. | -| `imageHash` | `undefined` \| `BigString` | The hash identifying the splash image. | -| `options?` | `Object` | The parameters for the building of the URL. | -| `options.format?` | `ImageFormat` | - | -| `options.size?` | `ImageSize` | - | - -#### Returns - -`string` \| `undefined` - -The link to the resource or `undefined` if the guild does not have a splash image set. - -#### Defined in - -[packages/utils/src/images.ts:103](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/images.ts#L103) - -___ - -### hasProperty - -▸ **hasProperty**<`T`, `Y`\>(`obj`, `prop`): obj is T & Record - -TS save way to check if a property exists in an object - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Object` | -| `Y` | extends `PropertyKey` = `string` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | `T` | -| `prop` | `Y` | - -#### Returns - -obj is T & Record - -#### Defined in - -[packages/utils/src/utils.ts:15](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/utils.ts#L15) - -___ - -### hidden - -▸ **hidden**(`str`): `string` - -Make the text hidden. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to hide | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:116](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L116) - -___ - -### iconBigintToHash - -▸ **iconBigintToHash**(`icon`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `icon` | `bigint` | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/hash.ts:14](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/hash.ts#L14) - -___ - -### iconHashToBigInt - -▸ **iconHashToBigInt**(`hash`): `bigint` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hash` | `string` | - -#### Returns - -`bigint` - -#### Defined in - -[packages/utils/src/hash.ts:1](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/hash.ts#L1) - -___ - -### inverse - -▸ **inverse**(`str`): `string` - -Invert background color and text color. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to invert its color | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:108](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L108) - -___ - -### isGetMessagesAfter - -▸ **isGetMessagesAfter**(`options`): options is GetMessagesAfter - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `GetMessagesOptions` | - -#### Returns - -options is GetMessagesAfter - -#### Defined in - -[packages/utils/src/typeguards.ts:4](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/typeguards.ts#L4) - -___ - -### isGetMessagesAround - -▸ **isGetMessagesAround**(`options`): options is GetMessagesAround - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `GetMessagesOptions` | - -#### Returns - -options is GetMessagesAround - -#### Defined in - -[packages/utils/src/typeguards.ts:12](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/typeguards.ts#L12) - -___ - -### isGetMessagesBefore - -▸ **isGetMessagesBefore**(`options`): options is GetMessagesBefore - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `GetMessagesOptions` | - -#### Returns - -options is GetMessagesBefore - -#### Defined in - -[packages/utils/src/typeguards.ts:8](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/typeguards.ts#L8) - -___ - -### isGetMessagesLimit - -▸ **isGetMessagesLimit**(`options`): options is GetMessagesLimit - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `GetMessagesOptions` | - -#### Returns - -options is GetMessagesLimit - -#### Defined in - -[packages/utils/src/typeguards.ts:16](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/typeguards.ts#L16) - -___ - -### italic - -▸ **italic**(`str`): `string` - -Make the text italic. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make italic | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:92](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L92) - -___ - -### magenta - -▸ **magenta**(`str`): `string` - -Set text color to magenta. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make magenta | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:172](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L172) - -___ - -### nextRefill - -▸ **nextRefill**(`bucket`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bucket` | [`LeakyBucket`](../interfaces/LeakyBucket.md) | - -#### Returns - -`number` - -#### Defined in - -[packages/utils/src/bucket.ts:106](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/bucket.ts#L106) - -___ - -### processReactionString - -▸ **processReactionString**(`reaction`): `string` - -Converts an reaction emoji unicode string to the discord required form of name:id - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `reaction` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/reactions.ts:2](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/reactions.ts#L2) - -___ - -### red - -▸ **red**(`str`): `string` - -Set text color to red. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make red | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:140](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L140) - -___ - -### removeTokenPrefix - -▸ **removeTokenPrefix**(`token?`, `type?`): `string` - -Removes the Bot before the token. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `token?` | `string` | `undefined` | -| `type` | ``"GATEWAY"`` \| ``"REST"`` | `'REST'` | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/token.ts:4](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/token.ts#L4) - -___ - -### reset - -▸ **reset**(`str`): `string` - -Reset the text modified - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to reset | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:68](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L68) - -___ - -### rgb24 - -▸ **rgb24**(`str`, `color`): `string` - -Set text color using 24bit rgb. -`color` can be a number in range `0x000000` to `0xffffff` or -an `Rgb`. - -To produce the color magenta: - -```ts - import { rgb24 } from "./colors.ts"; - rgb24("foo", 0xff00ff); - rgb24("foo", {r: 255, g: 0, b: 255}); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text color to apply 24bit rgb to | -| `color` | `number` \| [`Rgb`](../interfaces/Rgb.md) | code | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:439](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L439) - -___ - -### rgb8 - -▸ **rgb8**(`str`, `color`): `string` - -Set text color using paletted 8bit colors. -https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text color to apply paletted 8bit colors to | -| `color` | `number` | code | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:410](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L410) - -___ - -### setColorEnabled - -▸ **setColorEnabled**(`value`): `void` - -Set changing text color to enabled or disabled - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[packages/utils/src/colors.ts:29](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L29) - -___ - -### snakeToCamelCase - -▸ **snakeToCamelCase**(`str`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `str` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/casing.ts:36](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/casing.ts#L36) - -___ - -### snakelize - -▸ **snakelize**<`T`\>(`object`): `Snakelize`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `T` | - -#### Returns - -`Snakelize`<`T`\> - -#### Defined in - -[packages/utils/src/casing.ts:19](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/casing.ts#L19) - -___ - -### strikethrough - -▸ **strikethrough**(`str`): `string` - -Put horizontal line through the center of the text. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to strike through | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:124](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L124) - -___ - -### stripColor - -▸ **stripColor**(`string`): `string` - -Remove ANSI escape codes from the string. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `string` | `string` | to remove ANSI escape codes from | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:481](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L481) - -___ - -### underline - -▸ **underline**(`str`): `string` - -Make the text underline. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to underline | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:100](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L100) - -___ - -### updateTokens - -▸ **updateTokens**(`bucket`): `number` - -Update the tokens of that bucket. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bucket` | [`LeakyBucket`](../interfaces/LeakyBucket.md) | - -#### Returns - -`number` - -The amount of current available tokens. - -#### Defined in - -[packages/utils/src/bucket.ts:95](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/bucket.ts#L95) - -___ - -### urlToBase64 - -▸ **urlToBase64**(`url`): `Promise`<`string`\> - -Converts a url to base 64. Useful for example, uploading/creating server emojis. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/utils/src/urlToBase64.ts:4](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/urlToBase64.ts#L4) - -___ - -### white - -▸ **white**(`str`): `string` - -Set text color to white. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make white | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:188](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L188) - -___ - -### yellow - -▸ **yellow**(`str`): `string` - -Set text color to yellow. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `str` | `string` | text to make yellow | - -#### Returns - -`string` - -#### Defined in - -[packages/utils/src/colors.ts:156](https://github.com/discordeno/discordeno/blob/b8c25357/packages/utils/src/colors.ts#L156)