7b6190da01
* Fix docs for Guild#pruneMembers * ClientApplication returns * Guild#deleteEmoji * Guild#setRolePosition takes RoleResolvable * Client#fetchApplication returns ClientApplication not Oauth2Application * ClientDataResolver#resolveImage can return null * ClientApplication#toString small example * Guild#allowDMs now has a only for user accounts warning * ClientUserSettings#patch is private and setGuildPosition has a user account warning * Role#setPermissions can take PermissionResolvable, not just String * ChannelCreationOverwrites is for a role or a member, not for a "group" * Fix ChannelData#userlimit string being wrong "The user limit of voice the channel" :lul: * ChannelResolvable is only for Channel or Snowflake * EmojiIdentifierResolvable supports Snowflakes * UserResolvable doesn't take a guild * Make patch functions private * Remove examples * Webhoox#edit options.name defaults to the webhook name * Make VoiceConnection functions private * Am dum The whole ClientUserSettings category is only for self bots soo * Value for update functions is * * Make update functions be private * Fix GuildEditData missing Ssytemchannel property * PermissionOverwriteOptions can accept null as an option (Why did no-one document this?)
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 install discord.js --save
With voice support (node-opus): npm install discord.js node-opus --save
With voice support (opusscript): npm install discord.js opusscript --save
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
- bufferutil to greatly speed up the WebSocket when not using uws (
npm install bufferutil --save) - erlpack for significantly faster WebSocket data (de)serialisation (
npm install hammerandchisel/erlpack --save) - One of the following packages can be installed for faster voice packet encryption and decryption:
- sodium (
npm install sodium --save) - libsodium.js (
npm install libsodium-wrappers --save)
- sodium (
- uws for a much faster WebSocket connection (
npm install uws --save)
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 server
- Discord API server
- GitHub
- NPM
- Related libraries (see also discord-rpc)
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.