discord.pes
TypeScript icon, indicating that this package has built-in type declarations

1.7.2 • Public • Published


Discord server NPM version NPM downloads Build status Dependencies Patreon

npm installnfo

About

discord.pes 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.pes
With voice support (node-opus): npm install discord.js node-opus
With voice support (opusscript): npm install 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 install zlib-sync)
  • erlpack for significantly faster WebSocket data (de)serialisation (npm install discordapp/erlpack)
  • One of the following packages can be installed for faster voice packet encryption and decryption:
  • uws for a much faster WebSocket connection (npm install @discordjs/uws)
  • bufferutil for a much faster WebSocket connection when not using uws (npm install bufferutil)

Example usage

const Discord = require('discord.pes');
const client = new Discord.Client();
 
client.on('ready', () => {
  console.log(`Logged in as ${client.user.tag}!`);
});
 
client.on('message', msg => {
  if (msg.content === 'ping') {
    msg.reply('pong');
  }
});
 
client.login('token');

Links

Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the documentation used for the remix and making discord.pes.
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.

All copyrights are from their respective owners.

Package Sidebar

Install

npm i discord.pes

Weekly Downloads

1

Version

1.7.2

License

Apache-2.0

Unpacked Size

633 kB

Total Files

172

Last publish

Collaborators

  • discord.pes