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(Partials): add link to the guide (#5982)

Browse Source
This commit is contained in:
Rodry
2021-07-01 09:58:27 +01:00
committed by GitHub
parent 9ac68670d7
commit 58183d425b
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/util/Constants.js
View File

@@ -41,7 +41,8 @@ const { Error, RangeError } = require('../errors');
* 401, 403, or 429) in a 10 minute window between emitted warnings (0 for no warnings). That is, if set to 500, * 401, 403, or 429) in a 10 minute window between emitted warnings (0 for no warnings). That is, if set to 500,
* warnings will be emitted at invalid request number 500, 1000, 1500, and so on. * warnings will be emitted at invalid request number 500, 1000, 1500, and so on.
* @property {PartialType[]} [partials] Structures allowed to be partial. This means events can be emitted even when * @property {PartialType[]} [partials] Structures allowed to be partial. This means events can be emitted even when
* they're missing all the data for a particular structure. See the "Partials" topic listed in the sidebar for some * they're missing all the data for a particular structure. See the "Partial Structures" topic on the
* [guide](https://discordjs.guide/popular-topics/partials.html) for some
* important usage information, as partials require you to put checks in place when handling data. * important usage information, as partials require you to put checks in place when handling data.
* @property {number} [restWsBridgeTimeout=5000] Maximum time permitted between REST responses and their * @property {number} [restWsBridgeTimeout=5000] Maximum time permitted between REST responses and their
* corresponding websocket events * corresponding websocket events
@@ -306,8 +307,8 @@ exports.ShardEvents = {
* * GUILD_MEMBER * * GUILD_MEMBER
* * MESSAGE * * MESSAGE
* * REACTION * * REACTION
* <warn>Partials require you to put checks in place when handling data, read the Partials topic listed in the * <warn>Partials require you to put checks in place when handling data. See the "Partial Structures" topic on the
* sidebar for more information.</warn> * [guide](https://discordjs.guide/popular-topics/partials.html) for more information.</warn>
* @typedef {string} PartialType * @typedef {string} PartialType
*/ */
exports.PartialTypes = keyMirror(['USER', 'CHANNEL', 'GUILD_MEMBER', 'MESSAGE', 'REACTION']); exports.PartialTypes = keyMirror(['USER', 'CHANNEL', 'GUILD_MEMBER', 'MESSAGE', 'REACTION']);