Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-15 11:03:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Co-authored-by: Antonio Román <kyradiscord@gmail.com>
This commit is contained in:
Carter
2021-03-28 21:51:42 -06:00
committed by GitHub
parent 624a4464ca
commit 685b2604e4
18 changed files with 56 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -67,8 +67,8 @@ For production bots, using @discordjs/opus should be considered a necessity, esp
## Example usage ## Example usage
```js ```js
const Discord = require('discord.js'); const { Client, Intents } = require('discord.js');
const client = new Discord.Client(); const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
client.on('ready', () => { client.on('ready', () => {
console.log(`Logged in as ${client.user.tag}!`); console.log(`Logged in as ${client.user.tag}!`);

16
docs/examples/attachments.md
View File

@@ -10,10 +10,10 @@ The following examples use [MessageAttachment](/#/docs/main/master/class/Message
```js ```js
// Extract the required classes from the discord.js module // 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 // 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 * 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 ```js
// Extract the required classes from the discord.js module // 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 // 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 * 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 ```js
// Extract the required classes from the discord.js module // 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 // 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 * 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 ```js
// Extract the required classes from the discord.js module // 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 // Import the native fs module
const fs = require('fs'); const fs = require('fs');
// Create an instance of a Discord client // 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 * The ready event is vital, it means that only _after_ this will your bot start reacting to information

4
docs/examples/avatars.js
View File

@@ -5,10 +5,10 @@
*/ */
// Import the discord.js module // Import the discord.js module
const Discord = require('discord.js'); const { Client, Intents } = require('discord.js');
// Create an instance of a Discord client // 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 * The ready event is vital, it means that only _after_ this will your bot start reacting to information

4
docs/examples/embed.js
View File

@@ -5,10 +5,10 @@
*/ */
// Extract the required classes from the discord.js module // 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 // 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 * The ready event is vital, it means that only _after_ this will your bot start reacting to information

6
docs/examples/greeting.js
View File

@@ -5,10 +5,12 @@
*/ */
// Import the discord.js module // Import the discord.js module
const Discord = require('discord.js'); const { Client, Intents } = require('discord.js');
// Create an instance of a Discord client // 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 * The ready event is vital, it means that only _after_ this will your bot start reacting to information

8
docs/examples/moderation.md
View File

@@ -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 ```js
// Import the discord.js module // Import the discord.js module
const Discord = require('discord.js'); const { Client, Intents } = require('discord.js');
// Create an instance of a Discord client // 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 * 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 ```js
// Import the discord.js module // Import the discord.js module
const Discord = require('discord.js'); const { Client, Intents } = require('discord.js');
// Create an instance of a Discord client // 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 * The ready event is vital, it means that only _after_ this will your bot start reacting to information

4
docs/examples/ping.js
View File

@@ -5,10 +5,10 @@
*/ */
// Import the discord.js module // Import the discord.js module
const Discord = require('discord.js'); const { Client, Intents } = require('discord.js');
// Create an instance of a Discord client // 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 * The ready event is vital, it means that only _after_ this will your bot start reacting to information

6
docs/examples/webhook.js
View File

@@ -5,15 +5,15 @@
*/ */
// Import the discord.js module // Import the discord.js module
const Discord = require('discord.js'); const { WebhookClient } = require('discord.js');
/* /*
* Create a new webhook * 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. * 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 * https://discord.com/api/webhooks/12345678910/T0kEn0fw3Bh00K
* ^^^^^^^^^^ ^^^^^^^^^^^^ * ^^^^^^^^^^^ ^^^^^^^^^^^^^^
* Webhook ID Webhook Token * 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 // Send a message using the webhook
hook.send('I am now alive!'); hook.send('I am now alive!');

4
docs/general/welcome.md
View File

@@ -59,8 +59,8 @@ For production bots, using @discordjs/opus should be considered a necessity, esp
## Example usage ## Example usage
```js ```js
const Discord = require('discord.js'); const { Client, Intents } = require('discord.js');
const client = new Discord.Client(); const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
client.on('ready', () => { client.on('ready', () => {
console.log(`Logged in as ${client.user.tag}!`); console.log(`Logged in as ${client.user.tag}!`);

4
docs/topics/voice.md
View File

@@ -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. as it allows us to obtain a `VoiceConnection` that we can start to stream audio with.
```js ```js
const Discord = require('discord.js'); const { Client, Intents } = require('discord.js');
const client = new Discord.Client(); const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES, Intents.FLAGS.GUILD_VOICE_STATES] });
client.login('token here'); client.login('token here');

4
test/createGuild.js
View File

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

6
test/random.js
View File

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

6
test/reactionCollectorCreated.test.js
View File

@@ -1,9 +1,11 @@
'use strict'; 'use strict';
const { token, guildId, channelId, messageId } = require('./auth.js'); 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 () => { client.on('ready', async () => {
const guild = client.guilds.cache.get(guildId); const guild = client.guilds.cache.get(guildId);

10
test/sendtest.js
View File

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

5
test/shard.js
View File

@@ -1,9 +1,10 @@
'use strict'; 'use strict';
const { token } = require('./auth.json'); 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], shards: process.argv[2],
shardCount: process.argv[3], shardCount: process.argv[3],
intents: Discord.Intents.NON_PRIVILEGED, intents: Discord.Intents.NON_PRIVILEGED,

5
test/tester1000.js
View File

@@ -1,12 +1,13 @@
'use strict'; 'use strict';
const { token, prefix, owner } = require('./auth.js'); const { token, prefix, owner } = require('./auth.js');
const Discord = require('../src'); const { Client, Intents } = require('../src');
// eslint-disable-next-line no-console // eslint-disable-next-line no-console
const log = (...args) => console.log(process.uptime().toFixed(3), ...args); 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, shardCount: 2,
intents: Discord.Intents.NON_PRIVILEGED, intents: Discord.Intents.NON_PRIVILEGED,
}); });

6
test/voice.js
View File

@@ -3,11 +3,11 @@
const ytdl = require('ytdl-core'); const ytdl = require('ytdl-core');
const auth = require('./auth.js'); 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: [], partials: [],
intents: Discord.Intents.NON_PRIVILEGED,
}); });
client client

12
test/webhooktest.js
View File

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