c4b5736a16
* refactor/fix(DataStores): move instantiating of store related classes into the relevant create methods and fixed FetchMemberOptions * Renamed ChannelStore's constructor parameter for claritiy * define client property before creating items from passed iterable to avoid the client property being undefined * Fix fetching members with a limit * add static Channel#create back and moved channel instantiating there * make ChannelStore's constructor accept an iterable * make iterable an optional parameter, allow to just pass client and options * fixed a little typo in docs of <User>.displayAvatarURL() (#1872) * Rewrite presence a little bit (#1853) * such presence many good * Update PresenceStore.js * Update index.js * Update ClientPresenceStore.js * Update Presence.js * Update ClientPresenceStore.js * Update ClientUser.js * Update Presence.js * add timestamps and party * Update Presence.js * Update PresenceStore.js * Update ClientPresenceStore.js * Update ClientPresenceStore.js * fix: made options.type optional in ClientUser#setActivity (#1875) * fix: made options.type optional in ClientUser#setActivity * some changes, smol fix due to too many types being possible, it should just be defaulted to 0. this means streamers will have to set the type manually, though. also mistake with activity.name check * docs(Collection): Adjust exists documentation (#1876) Since the return value of Collection#exists is basically just a boolean of Collection#find's result, the same documentation and arguments can and should be applied. * refactor(Emoji): remove Guild#deleteEmoji in favour of Emoji#delete (#1877) * refactor/fix(DataStores): move instantiating of store related classes into the relevant create methods and fixed FetchMemberOptions * Renamed ChannelStore's constructor parameter for claritiy * define client property before creating items from passed iterable to avoid the client property being undefined * Fix fetching members with a limit * add static Channel#create back and moved channel instantiating there * make ChannelStore's constructor accept an iterable * make iterable an optional parameter, allow to just pass client and options * rebase, this time with saving the file * address issue with falsy activity throwing errors when setting client's presence
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.