discord.js


Discord server npm version npm downloads Build status Code coverage

Vercel Cloudflare Workers

## About `@discordjs/core` is a thinly abstracted wrapper around the "core" components of the Discord API: REST, and gateway. ## Installation **Node.js 18 or newer is required.** ```sh npm install @discordjs/core yarn add @discordjs/core pnpm add @discordjs/core ``` ## Example usage ```ts import { REST } from '@discordjs/rest'; import { WebSocketManager } from '@discordjs/ws'; import { GatewayDispatchEvents, GatewayIntentBits, InteractionType, MessageFlags, Client } from '@discordjs/core'; // Create REST and WebSocket managers directly const rest = new REST({ version: '10' }).setToken(process.env.DISCORD_TOKEN); const gateway = new WebSocketManager({ token: process.env.DISCORD_TOKEN, intents: GatewayIntentBits.GuildMessages | GatewayIntentBits.MessageContent, rest, }); // Create a client to emit relevant events. const client = new Client({ rest, gateway }); // Listen for interactions // Each event contains an `api` prop along with the event data that allows you to interface with the Discord REST API client.on(GatewayDispatchEvents.InteractionCreate, async ({ data: interaction, api }) => { if (interaction.type !== InteractionType.ApplicationCommand || interaction.data.name !== 'ping') { return; } await api.interactions.reply(interaction.id, interaction.token, { content: 'Pong!', flags: MessageFlags.Ephemeral }); }); // Listen for the ready event client.once(GatewayDispatchEvents.Ready, () => console.log('Ready!')); // Start the WebSocket connection. gateway.connect(); ``` ## Independent REST API Usage ```ts // Create REST instance const rest = new REST({ version: '10' }).setToken(token); // Pass into API const api = new API(rest); // Fetch a guild using the API wrapper const guild = await api.guilds.get('1234567891011'); ``` ## Links - [Website][website] ([source][website-source]) - [Documentation][documentation] - [Guide][guide] ([source][guide-source]) Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library. - [discord.js Discord server][discord] - [Discord API Discord server][discord-api] - [GitHub][source] - [npm][npm] - [Related libraries][related-libs] ## Contributing Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the [documentation][documentation]. See [the contribution guide][contributing] if you'd like to submit a PR. ## Help If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. [website]: https://discord.js.org [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website [documentation]: https://discord.js.org/docs/packages/core/stable [guide]: https://discordjs.guide/ [guide-source]: https://github.com/discordjs/guide [guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html [discord]: https://discord.gg/djs [discord-api]: https://discord.gg/discord-api [source]: https://github.com/discordjs/discord.js/tree/main/packages/core [npm]: https://www.npmjs.com/package/@discordjs/core [related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries [contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md