summaryrefslogtreecommitdiff
path: root/node_modules/discord.js/src/util/Partials.js
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/discord.js/src/util/Partials.js')
-rw-r--r--node_modules/discord.js/src/util/Partials.js44
1 files changed, 44 insertions, 0 deletions
diff --git a/node_modules/discord.js/src/util/Partials.js b/node_modules/discord.js/src/util/Partials.js
new file mode 100644
index 0000000..31d9223
--- /dev/null
+++ b/node_modules/discord.js/src/util/Partials.js
@@ -0,0 +1,44 @@
+'use strict';
+
+const { createEnum } = require('./Enums');
+
+/**
+ * The enumeration for partials.
+ * ```js
+ * import { Client, Partials } from 'discord.js';
+ *
+ * const client = new Client({
+ * intents: [
+ * // Intents...
+ * ],
+ * partials: [
+ * Partials.User, // We want to receive uncached users!
+ * Partials.Message // We want to receive uncached messages!
+ * ]
+ * });
+ * ```
+ * @typedef {Object} Partials
+ * @property {number} User The partial to receive uncached users.
+ * @property {number} Channel The partial to receive uncached channels.
+ * <info>This is required to receive direct messages!</info>
+ * @property {number} GuildMember The partial to receive uncached guild members.
+ * @property {number} Message The partial to receive uncached messages.
+ * @property {number} Reaction The partial to receive uncached reactions.
+ * @property {number} GuildScheduledEvent The partial to receive uncached guild scheduled events.
+ * @property {number} ThreadMember The partial to receive uncached thread members.
+ */
+
+// JSDoc for IntelliSense purposes
+/**
+ * @type {Partials}
+ * @ignore
+ */
+module.exports = createEnum([
+ 'User',
+ 'Channel',
+ 'GuildMember',
+ 'Message',
+ 'Reaction',
+ 'GuildScheduledEvent',
+ 'ThreadMember',
+]);