d5b0cf9ffb
* add Permissions.toArray() * accept Permissions objects to Permissions.missing() * accept Permissions as parameter to Permissions.has() * style fixes * remove redundant line, update JSDoc for Permission.resolve() * JSDoc, style, and checkAdmin fixes * add Permissions.resolveToObject() * accept PermissionResolvable to Permissions.missing() * remove `resolveToObject`, fix constructor JSDoc * remove redundant parameter type * fix `Permissions.missing()` * fix checkAdmin * update Permissions.toArray() description * eliminate ambiguity in Permissions.toArray() description * add backticks to permission example * remove irrelevant type in Permission ctor description * use this.constructor to properly support OOP * use simplified approach for Permissions.toArray() * fix return type on Permissions.toArray() * move `Permissions#toArray` to more suitable position * bitwise approach to `Permissions#missing` * allow `Permissions` to be iterated over * don't checkAdmin on return array * remove unnecessary conditional * fix JSDoc indentation * use simpler & more reliable approach for missing() * update PermissionResolvable typedef
About
discord.js is a powerful node.js module that allows you to interact with the Discord API very easily.
- Object-oriented
- Predictable abstractions
- Performant
- 100% coverage of the Discord API
Installation
Node.js 8.0.0 or newer is required.
Ignore any warnings about unmet peer dependencies, as they're all optional.
Without voice support: npm i discord.js
With voice support (node-opus): npm i discord.js node-opus
With voice support (opusscript): npm i discord.js opusscript
Audio engines
The preferred audio engine is node-opus, as it performs significantly better than opusscript. When both are available, discord.js will automatically choose node-opus. Using opusscript is only recommended for development environments where node-opus is tough to get working. For production bots, using node-opus should be considered a necessity, especially if they're going to be running on multiple servers.
Optional packages
- zlib-sync for significantly faster WebSocket data inflation (
npm i zlib-sync) - erlpack for significantly faster WebSocket data (de)serialisation (
npm i discordapp/erlpack) - One of the following packages can be installed for faster voice packet encryption and decryption:
- sodium (
npm i sodium) - libsodium.js (
npm i libsodium-wrappers)
- sodium (
- uws for a much faster WebSocket connection (
npm i uws) - bufferutil for a much faster WebSocket connection when not using uws (
npm i bufferutil)
Example usage
const Discord = require('discord.js');
const client = new Discord.Client();
client.on('ready', () => {
console.log('I am ready!');
});
client.on('message', message => {
if (message.content === 'ping') {
message.reply('pong');
}
});
client.login('your token');
Links
- Website (source)
- Documentation
- Discord.js Discord server
- Discord API Discord server
- GitHub
- NPM
- Related libraries
Extensions
Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
documentation.
See the contribution guide 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.