docs: update docs and examples for #4879 (#5323)

Co-authored-by: Antonio Román <[email protected]>
discordjs · Mar 29, 2021 · 685b260 · 685b260
1 parent 624a446
commit 685b260
Show file tree

Hide file tree

Showing 18 changed files with 56 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -67,8 +67,8 @@ For production bots, using @discordjs/opus should be considered a necessity, esp
 ## Example usage
 
 ```js
-const Discord = require('discord.js');
-const client = new Discord.Client();
+const { Client, Intents } = require('discord.js');
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 client.on('ready', () => {
   console.log(`Logged in as ${client.user.tag}!`);

diff --git a/docs/examples/attachments.md b/docs/examples/attachments.md
@@ -10,10 +10,10 @@ The following examples use [MessageAttachment](/#/docs/main/master/class/Message
 
 ```js
 // Extract the required classes from the discord.js module
-const { Client, MessageAttachment } = require('discord.js');
+const { Client, Intents, MessageAttachment } = require('discord.js');
 
 // Create an instance of a Discord client
-const client = new Client();
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 /**
  * The ready event is vital, it means that only _after_ this will your bot start reacting to information
@@ -45,10 +45,10 @@ But what if you want to send an attachment with a message content? Fear not, for
 
 ```js
 // Extract the required classes from the discord.js module
-const { Client, MessageAttachment } = require('discord.js');
+const { Client, Intents, MessageAttachment } = require('discord.js');
 
 // Create an instance of a Discord client
-const client = new Client();
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 /**
  * The ready event is vital, it means that only _after_ this will your bot start reacting to information
@@ -82,10 +82,10 @@ Sending a local file isn't hard either! We'll be using [MessageAttachment](/#/do
 
 ```js
 // Extract the required classes from the discord.js module
-const { Client, MessageAttachment } = require('discord.js');
+const { Client, Intents, MessageAttachment } = require('discord.js');
 
 // Create an instance of a Discord client
-const client = new Client();
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 /**
  * The ready event is vital, it means that only _after_ this will your bot start reacting to information
@@ -120,13 +120,13 @@ You can use any buffer you want, and send it. Just make sure to overwrite the fi
 
 ```js
 // Extract the required classes from the discord.js module
-const { Client, MessageAttachment } = require('discord.js');
+const { Client, Intents, MessageAttachment } = require('discord.js');
 
 // Import the native fs module
 const fs = require('fs');
 
 // Create an instance of a Discord client
-const client = new Client();
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 /**
  * The ready event is vital, it means that only _after_ this will your bot start reacting to information

diff --git a/docs/examples/avatars.js b/docs/examples/avatars.js
@@ -5,10 +5,10 @@
  */
 
 // Import the discord.js module
-const Discord = require('discord.js');
+const { Client, Intents } = require('discord.js');
 
 // Create an instance of a Discord client
-const client = new Discord.Client();
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 /**
  * The ready event is vital, it means that only _after_ this will your bot start reacting to information

diff --git a/docs/examples/embed.js b/docs/examples/embed.js
@@ -5,10 +5,10 @@
  */
 
 // Extract the required classes from the discord.js module
-const { Client, MessageEmbed } = require('discord.js');
+const { Client, Intents, MessageEmbed } = require('discord.js');
 
 // Create an instance of a Discord client
-const client = new Client();
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 /**
  * The ready event is vital, it means that only _after_ this will your bot start reacting to information

diff --git a/docs/examples/greeting.js b/docs/examples/greeting.js
@@ -5,10 +5,12 @@
  */
 
 // Import the discord.js module
-const Discord = require('discord.js');
+const { Client, Intents } = require('discord.js');
 
 // Create an instance of a Discord client
-const client = new Discord.Client();
+// Note: you __MUST__ have the GUILD_MEMBERS intent toggled on the dashboard
+// see https://discordjs.guide/popular-topics/intents.html for more
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MEMBERS] });
 
 /**
  * The ready event is vital, it means that only _after_ this will your bot start reacting to information

diff --git a/docs/examples/moderation.md b/docs/examples/moderation.md
@@ -8,10 +8,10 @@ Let's say you have a member that you'd like to kick. Here is an example of how y
 
 ```js
 // Import the discord.js module
-const Discord = require('discord.js');
+const { Client, Intents } = require('discord.js');
 
 // Create an instance of a Discord client
-const client = new Discord.Client();
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 /**
  * The ready event is vital, it means that only _after_ this will your bot start reacting to information
@@ -80,10 +80,10 @@ Banning works the same way as kicking, but it has slightly more options that can
 
 ```js
 // Import the discord.js module
-const Discord = require('discord.js');
+const { Client, Intents } = require('discord.js');
 
 // Create an instance of a Discord client
-const client = new Discord.Client();
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 /**
  * The ready event is vital, it means that only _after_ this will your bot start reacting to information

diff --git a/docs/examples/ping.js b/docs/examples/ping.js
@@ -5,10 +5,10 @@
  */
 
 // Import the discord.js module
-const Discord = require('discord.js');
+const { Client, Intents } = require('discord.js');
 
 // Create an instance of a Discord client
-const client = new Discord.Client();
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 /**
  * The ready event is vital, it means that only _after_ this will your bot start reacting to information

diff --git a/docs/examples/webhook.js b/docs/examples/webhook.js
@@ -5,15 +5,15 @@
  */
 
 // Import the discord.js module
-const Discord = require('discord.js');
+const { WebhookClient } = require('discord.js');
 /*
  * Create a new webhook
  * The Webhooks ID and token can be found in the URL, when you request that URL, or in the response body.
  * https://discord.com/api/webhooks/12345678910/T0kEn0fw3Bh00K
- *                                  ^^^^^^^^^^  ^^^^^^^^^^^^ 
+ *                                  ^^^^^^^^^^^ ^^^^^^^^^^^^^^
  *                                  Webhook ID  Webhook Token
  */
-const hook = new Discord.WebhookClient('webhook id', 'webhook token');
+const hook = new WebhookClient('webhook id', 'webhook token');
 
 // Send a message using the webhook
 hook.send('I am now alive!');
diff --git a/docs/general/welcome.md b/docs/general/welcome.md
@@ -59,8 +59,8 @@ For production bots, using @discordjs/opus should be considered a necessity, esp
 ## Example usage
 
 ```js
-const Discord = require('discord.js');
-const client = new Discord.Client();
+const { Client, Intents } = require('discord.js');
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 client.on('ready', () => {
   console.log(`Logged in as ${client.user.tag}!`);

diff --git a/docs/topics/voice.md b/docs/topics/voice.md
@@ -22,8 +22,8 @@ The example below reacts to a message and joins the sender's voice channel, catc
 as it allows us to obtain a `VoiceConnection` that we can start to stream audio with.
 
 ```js
-const Discord = require('discord.js');
-const client = new Discord.Client();
+const { Client, Intents } = require('discord.js');
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES, Intents.FLAGS.GUILD_VOICE_STATES] });
 
 client.login('token here');
 

diff --git a/test/createGuild.js b/test/createGuild.js
@@ -4,9 +4,7 @@ const assert = require('assert');
 const { token } = require('./auth');
 const { Client, Intents } = require('../src');
 
-const client = new Client({
-  intents: Intents.NON_PRIVILEGED,
-});
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 client.on('ready', async () => {
   try {

diff --git a/test/random.js b/test/random.js
@@ -5,13 +5,11 @@
 const request = require('superagent');
 const ytdl = require('ytdl-core');
 const { token, song } = require('./auth.js');
-const Discord = require('../src');
+const { Client, Intents } = require('../src');
 
 console.time('magic');
 
-const client = new Discord.Client({
-	intents: Discord.Intents.NON_PRIVILEGED
-});
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES, Intents.FLAGS.GUILD_MESSAGE_REACTIONS, Intents.FLAGS.GUILD_MEMBERS] });
 
 client
   .login(token)

diff --git a/test/reactionCollectorCreated.test.js b/test/reactionCollectorCreated.test.js
@@ -1,9 +1,11 @@
 'use strict';
 
 const { token, guildId, channelId, messageId } = require('./auth.js');
-const { Client, ReactionCollector } = require('../src');
+const { Client, Intents, ReactionCollector } = require('../src');
 
-const client = new Client();
+const client = new Client({
+  intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES, Intents.FLAGS.GUILD_MESSAGE_REACTIONS],
+});
 
 client.on('ready', async () => {
   const guild = client.guilds.cache.get(guildId);

diff --git a/test/sendtest.js b/test/sendtest.js
@@ -5,11 +5,9 @@ const path = require('path');
 const util = require('util');
 const fetch = require('node-fetch');
 const { owner, token } = require('./auth.js');
-const Discord = require('../src');
+const { Client, Intents, MessageAttachment, MessageEmbed } = require('../src');
 
-const client = new Discord.Client({
-  intents: Discord.Intents.NON_PRIVILEGED,
-});
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 const fill = c => Array(4).fill(c.repeat(1000));
 const buffer = l => fetch(l).then(res => res.buffer());
@@ -21,8 +19,8 @@ const linkA = 'https://lolisafe.moe/iiDMtAXA.png';
 const linkB = 'https://lolisafe.moe/9hSpedPh.png';
 const fileA = path.join(__dirname, 'blobReach.png');
 
-const embed = () => new Discord.MessageEmbed();
-const attach = (attachment, name) => new Discord.MessageAttachment(attachment, name);
+const embed = () => new MessageEmbed();
+const attach = (attachment, name) => new MessageAttachment(attachment, name);
 
 const tests = [
   m => m.channel.send('x'),

diff --git a/test/shard.js b/test/shard.js
@@ -1,9 +1,10 @@
 'use strict';
 
 const { token } = require('./auth.json');
-const Discord = require('../src');
+const { Client, Intents } = require('../src');
 
-const client = new Discord.Client({
+const client = new Client({
+  intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES],
   shards: process.argv[2],
   shardCount: process.argv[3],
   intents: Discord.Intents.NON_PRIVILEGED,

diff --git a/test/tester1000.js b/test/tester1000.js
@@ -1,12 +1,13 @@
 'use strict';
 
 const { token, prefix, owner } = require('./auth.js');
-const Discord = require('../src');
+const { Client, Intents } = require('../src');
 
 // eslint-disable-next-line no-console
 const log = (...args) => console.log(process.uptime().toFixed(3), ...args);
 
-const client = new Discord.Client({
+const client = new Client({
+  intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES],
   shardCount: 2,
   intents: Discord.Intents.NON_PRIVILEGED,
 });

diff --git a/test/voice.js b/test/voice.js
@@ -3,11 +3,11 @@
 
 const ytdl = require('ytdl-core');
 const auth = require('./auth.js');
-const Discord = require('../src');
+const { Client, Intents } = require('../src');
 
-const client = new Discord.Client({
+const client = new Client({
+  intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES, Intents.FLAGS.GUILD_PRESENCES],
   partials: [],
-  intents: Discord.Intents.NON_PRIVILEGED,
 });
 
 client

diff --git a/test/webhooktest.js b/test/webhooktest.js
@@ -5,11 +5,9 @@ const path = require('path');
 const util = require('util');
 const fetch = require('node-fetch');
 const { owner, token, webhookChannel, webhookToken } = require('./auth.js');
-const Discord = require('../src');
+const { Client, Intents, MessageAttachment, MessageEmbed, WebhookClient } = require('../src');
 
-const client = new Discord.Client({
-  intents: Discord.Intents.NON_PRIVILEGED,
-});
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
 
 const fill = c => Array(4).fill(c.repeat(1000));
 const buffer = l => fetch(l).then(res => res.buffer());
@@ -21,8 +19,8 @@ const linkA = 'https://lolisafe.moe/iiDMtAXA.png';
 const linkB = 'https://lolisafe.moe/9hSpedPh.png';
 const fileA = path.join(__dirname, 'blobReach.png');
 
-const embed = () => new Discord.MessageEmbed();
-const attach = (attachment, name) => new Discord.MessageAttachment(attachment, name);
+const embed = () => new MessageEmbed();
+const attach = (attachment, name) => new MessageAttachment(attachment, name);
 
 const tests = [
   (m, hook) => hook.send('x'),
@@ -121,7 +119,7 @@ client.on('message', async message => {
   if (message.author.id !== owner) return;
   const match = message.content.match(/^do (.+)$/);
   const hooks = [
-    { type: 'WebhookClient', hook: new Discord.WebhookClient(webhookChannel, webhookToken) },
+    { type: 'WebhookClient', hook: new WebhookClient(webhookChannel, webhookToken) },
     { type: 'TextChannel#fetchWebhooks', hook: await message.channel.fetchWebhooks().then(x => x.first()) },
     { type: 'Guild#fetchWebhooks', hook: await message.guild.fetchWebhooks().then(x => x.first()) },
   ];