mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-18 20:43:30 +01:00
fix(guide): Miscellaneous fixes (#11147)
* fix: miscellaneous fixes * docs: fix contributing link * fix: link * fix: you * fix: main links * fix: update source * fix: update link * fix: update update link * fix: [ * fix: remove locale * fix: update links * fix: update GitHub link --------- Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
Jiralite
@@ -81,7 +81,7 @@ After importing the `@napi-rs/canvas` module and initializing it, you should loa
|
||||
<Callout>
|
||||
`@napi-rs/canvas` works almost identical to HTML5 Canvas. You can read the HTML5 Canvas tutorials on
|
||||
[w3Schools](https://www.w3schools.com/html/html5_canvas.asp) and
|
||||
[MDN](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) for more information later!
|
||||
[MDN](https://developer.mozilla.org/docs/Web/API/Canvas_API) for more information later!
|
||||
</Callout>
|
||||
|
||||
```js lineNumbers=10 title="index.js"
|
||||
@@ -101,7 +101,7 @@ client.on(Events.InteractionCreate, async (interaction) => {
|
||||
|
||||
Now, you need to load the image you want to use into Canvas.
|
||||
|
||||
We'll be using [this image](https://github.com/discordjs/guide/blob/main/guide/popular-topics/images/canvas.jpg) as the background in the welcome image, but you can use whatever you want. Be sure to download the file, name it `wallpaper.jpg`, and save it inside the same directory as your main bot file.
|
||||
We'll be using [this image](https://github.com/discordjs/discord.js/blob/main/apps/guide/content/docs/legacy/popular-topics/images/canvas.jpg) as the background in the welcome image, but you can use whatever you want. Be sure to download the file, name it `wallpaper.jpg`, and save it inside the same directory as your main bot file.
|
||||
|
||||
```js lineNumbers=10 title="index.js"
|
||||
client.on(Events.InteractionCreate, async (interaction) => {
|
||||
@@ -222,7 +222,7 @@ client.on(Events.InteractionCreate, async (interaction) => {
|
||||
|
||||
<Callout>
|
||||
You can read more about `context.arc()` on [w3schools](https://www.w3schools.com/tags/canvas_arc.asp) or
|
||||
[MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/arc).
|
||||
[MDN](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/arc).
|
||||
</Callout>
|
||||
|
||||
### Adding in text
|
||||
|
||||
@@ -24,9 +24,9 @@ collector.on('end', (collected) => {
|
||||
});
|
||||
```
|
||||
|
||||
You can provide a `filter` key to the object parameter of `createMessageCollector()`. The value to this key should be a function that returns a boolean value to indicate if this message should be collected or not. To check for multiple conditions in your filter you can connect them using [logical operators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators#logical_operators). If you don't provide a filter all messages in the channel the collector was started on will be collected.
|
||||
You can provide a `filter` key to the object parameter of `createMessageCollector()`. The value to this key should be a function that returns a boolean value to indicate if this message should be collected or not. To check for multiple conditions in your filter you can connect them using [logical operators](https://developer.mozilla.org/docs/Web/JavaScript/Guide/Expressions_and_Operators#logical_operators). If you don't provide a filter all messages in the channel the collector was started on will be collected.
|
||||
|
||||
Note that the above example uses [implicit return](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions#function_body) for the filter function and passes it to the options object using the [object property shorthand](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer#property_definitions) notation.
|
||||
Note that the above example uses [implicit return](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Functions/Arrow_functions#function_body) for the filter function and passes it to the options object using the [object property shorthand](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/Object_initializer#property_definitions) notation.
|
||||
|
||||
If a message passes through the filter, it will trigger the `collect` event for the `collector` you've created. This message is then passed into the event listener as `collected` and the provided function is executed. In the above example, you simply log the message. Once the collector finishes collecting based on the provided end conditions the `end` event emits.
|
||||
|
||||
@@ -81,7 +81,7 @@ interaction.reply({ content: item.question, withResponse: true }).then((response
|
||||
|
||||
<Callout>
|
||||
If you don't understand how `.some()` works, you can read about it in more detail
|
||||
[here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some).
|
||||
[here](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/some).
|
||||
</Callout>
|
||||
|
||||
In this filter, you iterate through the answers to find what you want. You would like to ignore the case because simple typos can happen, so you convert each answer to its lowercase form and check if it's equal to the response in lowercase form as well. In the options section, you only want to allow one answer to pass through, hence the `max: 1` setting.
|
||||
|
||||
@@ -20,7 +20,7 @@ Example: `The messages must be an Array, Collection, or number.`
|
||||
|
||||
### JavaScript errors
|
||||
|
||||
JavaScript errors are thrown by node itself or by discord.js. These errors can easily be fixed by looking at the type of error and the stack trace. You can find a full list of types [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) and a list of common JavaScript errors [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors).
|
||||
JavaScript errors are thrown by node itself or by discord.js. These errors can easily be fixed by looking at the type of error and the stack trace. You can find a full list of types [here](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error) and a list of common JavaScript errors [here](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Errors).
|
||||
|
||||
Examples:
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Rather than blindly enabling all intents, consider what information you actually
|
||||
|
||||
## Privileged Intents
|
||||
|
||||
Discord defines some intents as "privileged" due to the data's sensitive nature. At the time of writing this article, privileged intents are `GuildPresences`, `MessageContent` and `GuildMembers`. If your bot is not verified and in less than 100 guilds, you can enable privileged gateway intents in the [Discord Developer Portal](https://discord.com/developers/applications) under "Privileged Gateway Intents" in the "Bot" section. If your bot is already verified or is about to [require verification](https://support-dev.discord.com/hc/en-us/articles/23926564536471), you need to request privileged intents. You can do this in your verification application or by reaching out to Discord's [support team](https://dis.gd/contact), including why you require access to each privileged intent.
|
||||
Discord defines some intents as "privileged" due to the data's sensitive nature. At the time of writing this article, privileged intents are `GuildPresences`, `MessageContent` and `GuildMembers`. If your bot is not verified and in less than 100 guilds, you can enable privileged gateway intents in the [Discord Developer Portal](https://discord.com/developers/applications) under "Privileged Gateway Intents" in the "Bot" section. If your bot is already verified or is about to [require verification](https://support-dev.discord.com/hc/articles/23926564536471), you need to request privileged intents. You can do this in your verification application or by reaching out to Discord's [support team](https://dis.gd/contact), including why you require access to each privileged intent.
|
||||
|
||||
Before storming off and doing so, you should stop and carefully think about if you need these events. Discord made them opt-in so users across the platform can enjoy a higher level of [privacy](https://en.wikipedia.org/wiki/Privacy_by_design). Presences can expose quite a bit of personal information, including the games being played and overall online time. You might find that it isn't necessary for your bot to have this level of information about all guild members at all times, considering you still get the command author as GuildMember from the command execution message and can fetch other targets separately.
|
||||
|
||||
@@ -75,6 +75,6 @@ If you want to view the built flags you can utilize the `.toArray()`, `.serializ
|
||||
|
||||
## More on Bitfields
|
||||
|
||||
Discord Intents and Permissions are stored in a 53-bit integer and calculated using bitwise operations. If you want to dive deeper into what's happening behind the curtains, check the [Wikipedia](https://en.wikipedia.org/wiki/Bit_field) and [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators#binary_bitwise_operators) articles on the topic.
|
||||
Discord Intents and Permissions are stored in a 53-bit integer and calculated using bitwise operations. If you want to dive deeper into what's happening behind the curtains, check the [Wikipedia](https://en.wikipedia.org/wiki/Bit_field) and [MDN](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators#binary_bitwise_operators) articles on the topic.
|
||||
|
||||
In discord.js, Permissions and Intents bitfields are represented as either the decimal value of said bit field or its referenced flags. Every position in a permissions bitfield represents one of these flags and its state (either referenced `1` or not referenced `0`).
|
||||
|
||||
@@ -49,7 +49,7 @@ if (message.partial) {
|
||||
|
||||
## Obtaining the full structure
|
||||
|
||||
Along with `.partial` to check if the structure you call it on is partial or not, the library also introduced a `.fetch()` method to retrieve the missing data from the API and complete the structure. The method returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) you need to handle. After the Promise resolves (and with it, the missing data arrived), you can use the structure as you would before.
|
||||
Along with `.partial` to check if the structure you call it on is partial or not, the library also introduced a `.fetch()` method to retrieve the missing data from the API and complete the structure. The method returns a [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise) you need to handle. After the Promise resolves (and with it, the missing data arrived), you can use the structure as you would before.
|
||||
|
||||
```js
|
||||
// [!code word:partial]
|
||||
|
||||
@@ -4,7 +4,7 @@ title: Permissions (extended)
|
||||
|
||||
## Discord's permission system
|
||||
|
||||
Discord permissions are stored in a 53-bit integer and calculated using bitwise operations. If you want to dive deeper into what's happening behind the curtains, check the [Wikipedia](https://en.wikipedia.org/wiki/Bit_field) and [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators#binary_bitwise_operators) articles on the topic.
|
||||
Discord permissions are stored in a 53-bit integer and calculated using bitwise operations. If you want to dive deeper into what's happening behind the curtains, check the [Wikipedia](https://en.wikipedia.org/wiki/Bit_field) and [MDN](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators#binary_bitwise_operators) articles on the topic.
|
||||
|
||||
In discord.js, permission bit fields are represented as either the decimal value of said bit field or its referenced flags.
|
||||
Every position in a permissions bit field represents one of these flags and its state (either referenced `1` or not referenced `0`).
|
||||
|
||||
@@ -183,7 +183,7 @@ If you try again with either of the code blocks above, you'll get the result you
|
||||
|
||||
<Callout>
|
||||
If you aren't familiar with Promises or `async`/`await`, you can read more about them on
|
||||
[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) or [our guide page on
|
||||
[MDN](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise) or [our guide page on
|
||||
async/await](../additional-info/async-await.md)!
|
||||
</Callout>
|
||||
|
||||
@@ -234,8 +234,8 @@ message.reactions.cache
|
||||
|
||||
<Callout>
|
||||
If you are not familiar with `Collection#filter` and
|
||||
[`Map.has()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/has) take the time
|
||||
to understand what they do and then come back.
|
||||
[`Map.has()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map/has) take the time to
|
||||
understand what they do and then come back.
|
||||
</Callout>
|
||||
|
||||
Removing reactions by a user is not as straightforward as removing by emoji or removing all reactions. The API does not provide a method for selectively removing the reactions of a user. This means you will have to iterate through reactions that include the user and remove them.
|
||||
|
||||
@@ -29,7 +29,7 @@ If you would like to get the webhook object that sent the message, you can use `
|
||||
Webhook fetching will always make use of collections and Promises. If you do not understand either concept, revise
|
||||
them, and then come back to this section. You can read about collections [here](../additional-info/collections), and
|
||||
Promises [here](../additional-info/async-await) and
|
||||
[here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises).
|
||||
[here](https://developer.mozilla.org/docs/Web/JavaScript/Guide/Using_promises).
|
||||
</Callout>
|
||||
|
||||
### Fetching all webhooks of a guild
|
||||
|
||||
Reference in New Issue
Block a user