@velliajs/discord 1.0.2 → 1.0.4

package/src/util/GuildMemberFlagsBitField.js

@@ -3,39 +3,16 @@
 const { GuildMemberFlags } = require('discord-api-types/v10');
 const BitField = require('./BitField');
 
-/**
- * Data structure that makes it easy to interact with a {@link GuildMember#flags} bitfield.
- * @extends {BitField}
- */
+
 class GuildMemberFlagsBitField extends BitField {
-  /**
-   * Numeric guild guild member flags.
-   * @type {GuildMemberFlags}
-   * @memberof GuildMemberFlagsBitField
-   */
+  
   static Flags = GuildMemberFlags;
 }
 
-/**
- * @name GuildMemberFlagsBitField
- * @kind constructor
- * @memberof GuildMemberFlagsBitField
- * @param {BitFieldResolvable} [bits=0] Bit(s) to read from
- */
-
-/**
- * Bitfield of the packed bits
- * @type {number}
- * @name GuildMemberFlagsBitField#bitfield
- */
-
-/**
- * Data that can be resolved to give a guild member flag bitfield. This can be:
- * * A string (see {@link GuildMemberFlagsBitField.Flags})
- * * A guild member flag
- * * An instance of GuildMemberFlagsBitField
- * * An Array of GuildMemberFlagsResolvable
- * @typedef {string|number|GuildMemberFlagsBitField|GuildMemberFlagsResolvable[]} GuildMemberFlagsResolvable
- */
+
+
+
+
+
 
 exports.GuildMemberFlagsBitField = GuildMemberFlagsBitField;

package/src/util/IntentsBitField.js

@@ -2,33 +2,14 @@
 const { GatewayIntentBits } = require('discord-api-types/v10');
 const BitField = require('./BitField');
 
-/**
- * Data structure that makes it easy to calculate intents.
- * @extends {BitField}
- */
+
 class IntentsBitField extends BitField {
-  /**
-   * Numeric WebSocket intents
-   * @type {GatewayIntentBits}
-   * @memberof IntentsBitField
-   */
+  
   static Flags = GatewayIntentBits;
 }
 
-/**
- * @name IntentsBitField
- * @kind constructor
- * @memberof IntentsBitField
- * @param {IntentsResolvable} [bits=0] Bit(s) to read from
- */
 
-/**
- * Data that can be resolved to give a permission number. This can be:
- * * A string (see {@link IntentsBitField.Flags})
- * * An intents flag
- * * An instance of {@link IntentsBitField}
- * * An array of IntentsResolvable
- * @typedef {string|number|IntentsBitField|IntentsResolvable[]} IntentsResolvable
- */
+
+
 
 module.exports = IntentsBitField;

package/src/util/LimitedCollection.js

@@ -3,20 +3,9 @@
 const { Collection } = require('@discordjs/collection');
 const { DiscordjsTypeError, ErrorCodes } = require('../errors');
 
-/**
- * Options for defining the behavior of a LimitedCollection
- * @typedef {Object} LimitedCollectionOptions
- * @property {?number} [maxSize=Infinity] The maximum size of the Collection
- * @property {?Function} [keepOverLimit=null] A function, which is passed the value and key of an entry, ran to decide
- * to keep an entry past the maximum size
- */
 
-/**
- * A Collection which holds a max amount of entries.
- * @extends {Collection}
- * @param {LimitedCollectionOptions} [options={}] Options for constructing the Collection.
- * @param {Iterable} [iterable=null] Optional entries passed to the Map constructor.
- */
+
+
 class LimitedCollection extends Collection {
   constructor(options = {}, iterable) {
     if (typeof options !== 'object' || options === null) {
@@ -33,16 +22,10 @@ class LimitedCollection extends Collection {
 
     super(iterable);
 
-    /**
-     * The max size of the Collection.
-     * @type {number}
-     */
+    
     this.maxSize = maxSize;
 
-    /**
-     * A function called to check if an entry should be kept when the Collection is at max size.
-     * @type {?Function}
-     */
+    
     this.keepOverLimit = keepOverLimit;
   }
 

package/src/util/MessageFlagsBitField.js

@@ -3,30 +3,14 @@
 const { MessageFlags } = require('discord-api-types/v10');
 const BitField = require('./BitField');
 
-/**
- * Data structure that makes it easy to interact with a {@link Message#flags} bitfield.
- * @extends {BitField}
- */
+
 class MessageFlagsBitField extends BitField {
-  /**
-   * Numeric message flags.
-   * @type {MessageFlags}
-   * @memberof MessageFlagsBitField
-   */
+  
   static Flags = MessageFlags;
 }
 
-/**
- * @name MessageFlagsBitField
- * @kind constructor
- * @memberof MessageFlagsBitField
- * @param {BitFieldResolvable} [bits=0] Bit(s) to read from
- */
-
-/**
- * Bitfield of the packed bits
- * @type {number}
- * @name MessageFlagsBitField#bitfield
- */
+
+
+
 
 module.exports = MessageFlagsBitField;

package/src/util/Options.js

@@ -4,95 +4,24 @@ const { DefaultRestOptions, DefaultUserAgentAppendix } = require('@discordjs/res
 const { toSnakeCase } = require('./Transformers');
 const { version } = require('../../package.json');
 
-/**
- * @typedef {Function} CacheFactory
- * @param {Function} manager The manager class the cache is being requested from.
- * @param {Function} holds The class that the cache will hold.
- * @returns {Collection} A Collection used to store the cache of the manager.
- */
-
-/**
- * Options for a client.
- * @typedef {Object} ClientOptions
- * @property {number|number[]|string} [shards] The shard's id to run, or an array of shard ids. If not specified,
- * the client will spawn {@link ClientOptions#shardCount} shards. If set to `auto`, it will fetch the
- * recommended amount of shards from Discord and spawn that amount
- * @property {number} [closeTimeout=5_000] The amount of time in milliseconds to wait for the close frame to be received
- * from the WebSocket. Don't have this too high/low. Its best to have it between 2_000-6_000 ms.
- * @property {number} [shardCount=1] The total amount of shards used by all processes of this bot
- * (e.g. recommended shard count, shard count of the ShardingManager)
- * @property {CacheFactory} [makeCache] Function to create a cache.
- * You can use your own function, or the {@link Options} class to customize the Collection used for the cache.
- * <warn>Overriding the cache used in `GuildManager`, `ChannelManager`, `GuildChannelManager`, `RoleManager`,
- * and `PermissionOverwriteManager` is unsupported and **will** break functionality</warn>
- * @property {MessageMentionOptions} [allowedMentions] The default value for {@link BaseMessageOptions#allowedMentions}
- * @property {Partials[]} [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 "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.
- * @property {boolean} [failIfNotExists=true] The default value for {@link MessageReplyOptions#failIfNotExists}
- * @property {PresenceData} [presence={}] Presence data to use upon login
- * @property {IntentsResolvable} intents Intents to enable for this connection
- * @property {number} [waitGuildTimeout=15_000] Time in milliseconds that clients with the
- * {@link GatewayIntentBits.Guilds} gateway intent should wait for missing guilds to be received before being ready.
- * @property {SweeperOptions} [sweepers={}] Options for cache sweeping
- * @property {WebsocketOptions} [ws] Options for the WebSocket
- * @property {RESTOptions} [rest] Options for the REST manager
- * @property {Function} [jsonTransformer] A function used to transform outgoing json data
- */
-
-/**
- * Options for {@link Sweepers} defining the behavior of cache sweeping
- * @typedef {Object<SweeperKey, SweepOptions>} SweeperOptions
- */
-
-/**
- * Options for sweeping a single type of item from cache
- * @typedef {Object} SweepOptions
- * @property {number} interval The interval (in seconds) at which to perform sweeping of the item
- * @property {number} [lifetime] How long an item should stay in cache until it is considered sweepable.
- * <warn>This property is only valid for the `invites`, `messages`, and `threads` keys. The `filter` property
- * is mutually exclusive to this property and takes priority</warn>
- * @property {GlobalSweepFilter} filter The function used to determine the function passed to the sweep method
- * <info>This property is optional when the key is `invites`, `messages`, or `threads` and `lifetime` is set</info>
- */
-
-/**
- * A function to determine what strategy to use for sharding internally.
- * ```js
- * (manager) => new WorkerShardingStrategy(manager, { shardsPerWorker: 2 })
- * ```
- * @typedef {Function} BuildStrategyFunction
- * @param {WSWebSocketManager} manager The WebSocketManager that is going to initiate the sharding
- * @returns {IShardingStrategy} The strategy to use for sharding
- */
-
-/**
- * WebSocket options (these are left as snake_case to match the API)
- * @typedef {Object} WebsocketOptions
- * @property {number} [large_threshold=50] Number of members in a guild after which offline users will no longer be
- * sent in the initial guild member list, must be between 50 and 250
- * @property {number} [version=10] The Discord gateway version to use <warn>Changing this can break the library;
- * only set this if you know what you are doing</warn>
- * @property {BuildStrategyFunction} [buildStrategy] Builds the strategy to use for sharding
- */
-
-/**
- * Contains various utilities for client options.
- */
+
+
+
+
+
+
+
+
+
+
+
+
+
 class Options extends null {
-  /**
-   * The default user agent appendix.
-   * @type {string}
-   * @memberof Options
-   * @private
-   */
+  
   static userAgentAppendix = `discord.js/${version} ${DefaultUserAgentAppendix}`.trimEnd();
 
-  /**
-   * The default client options.
-   * @returns {ClientOptions}
-   */
+  
   static createDefault() {
     return {
       closeTimeout: 5_000,
@@ -115,30 +44,14 @@ class Options extends null {
     };
   }
 
-  /**
-   * Create a cache factory using predefined settings to sweep or limit.
-   * @param {Object<string, LimitedCollectionOptions|number>} [settings={}] Settings passed to the relevant constructor.
-   * If no setting is provided for a manager, it uses Collection.
-   * If a number is provided for a manager, it uses that number as the max size for a LimitedCollection.
-   * If LimitedCollectionOptions are provided for a manager, it uses those settings to form a LimitedCollection.
-   * @returns {CacheFactory}
-   * @example
-   * // Store up to 200 messages per channel and 200 members per guild, always keeping the client member.
-   * Options.cacheWithLimits({
-   *    MessageManager: 200,
-   *    GuildMemberManager: {
-   *      maxSize: 200,
-   *      keepOverLimit: (member) => member.id === client.user.id,
-   *    },
-   *  });
-   */
+  
   static cacheWithLimits(settings = {}) {
     const { Collection } = require('@discordjs/collection');
     const LimitedCollection = require('./LimitedCollection');
 
     return manager => {
       const setting = settings[manager.name];
-      /* eslint-disable-next-line eqeqeq */
+      
       if (setting == null) {
         return new Collection();
       }
@@ -148,7 +61,7 @@ class Options extends null {
         }
         return new LimitedCollection({ maxSize: setting });
       }
-      /* eslint-disable-next-line eqeqeq */
+      
       const noLimit = setting.maxSize == null || setting.maxSize === Infinity;
       if (noLimit) {
         return new Collection();
@@ -157,37 +70,20 @@ class Options extends null {
     };
   }
 
-  /**
-   * Create a cache factory that always caches everything.
-   * @returns {CacheFactory}
-   */
+  
   static cacheEverything() {
     const { Collection } = require('@discordjs/collection');
     return () => new Collection();
   }
 
-  /**
-   * The default settings passed to {@link ClientOptions.makeCache}.
-   * The caches that this changes are:
-   * * `MessageManager` - Limit to 200 messages
-   * <info>If you want to keep default behavior and add on top of it you can use this object and add on to it, e.g.
-   * `makeCache: Options.cacheWithLimits({ ...Options.DefaultMakeCacheSettings, ReactionManager: 0 })`</info>
-   * @type {Object<string, LimitedCollectionOptions|number>}
-   */
+  
   static get DefaultMakeCacheSettings() {
     return {
       MessageManager: 200,
     };
   }
 
-  /**
-   * The default settings passed to {@link ClientOptions.sweepers}.
-   * The sweepers that this changes are:
-   * * `threads` - Sweep archived threads every hour, removing those archived more than 4 hours ago
-   * <info>If you want to keep default behavior and add on top of it you can use this object and add on to it, e.g.
-   * `sweepers: { ...Options.DefaultSweeperSettings, messages: { interval: 300, lifetime: 600 } }`</info>
-   * @type {SweeperOptions}
-   */
+  
   static get DefaultSweeperSettings() {
     return {
       threads: {
@@ -200,17 +96,8 @@ class Options extends null {
 
 module.exports = Options;
 
-/**
- * @external RESTOptions
- * @see {@link https://discord.js.org/docs/packages/rest/stable/RESTOptions:Interface}
- */
 
-/**
- * @external WSWebSocketManager
- * @see {@link https://discord.js.org/docs/packages/ws/stable/WebSocketManager:Class}
- */
 
-/**
- * @external IShardingStrategy
- * @see {@link https://discord.js.org/docs/packages/ws/stable/IShardingStrategy:Interface}
- */
+
+
+

package/src/util/Partials.js

@@ -2,37 +2,10 @@
 
 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',

package/src/util/PermissionsBitField.js

@@ -3,99 +3,44 @@
 const { PermissionFlagsBits } = require('discord-api-types/v10');
 const BitField = require('./BitField');
 
-/**
- * Data structure that makes it easy to interact with a permission bitfield. All {@link GuildMember}s have a set of
- * permissions in their guild, and each channel in the guild may also have {@link PermissionOverwrites} for the member
- * that override their default permissions.
- * @extends {BitField}
- */
+
 class PermissionsBitField extends BitField {
-  /**
-   * Numeric permission flags.
-   * @type {PermissionFlagsBits}
-   * @memberof PermissionsBitField
-   * @see {@link https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags}
-   */
+  
   static Flags = PermissionFlagsBits;
 
-  /**
-   * Bitfield representing every permission combined
-   * @type {bigint}
-   * @memberof PermissionsBitField
-   */
+  
   static All = Object.values(PermissionFlagsBits).reduce((all, p) => all | p, 0n);
 
-  /**
-   * Bitfield representing the default permissions for users
-   * @type {bigint}
-   * @memberof PermissionsBitField
-   */
+  
   static Default = BigInt(104324673);
 
-  /**
-   * Bitfield representing the permissions required for moderators of stage channels
-   * @type {bigint}
-   * @memberof PermissionsBitField
-   */
+  
   static StageModerator =
     PermissionFlagsBits.ManageChannels | PermissionFlagsBits.MuteMembers | PermissionFlagsBits.MoveMembers;
 
-  /**
-   * @type {bigint}
-   * @memberof PermissionsBitField
-   * @private
-   */
+  
   static DefaultBit = BigInt(0);
 
-  /**
-   * Bitfield of the packed bits
-   * @type {bigint}
-   * @name PermissionsBitField#bitfield
-   */
+  
 
-  /**
-   * Data that can be resolved to give a permission number. This can be:
-   * * A string (see {@link PermissionsBitField.Flags})
-   * * A permission number
-   * * An instance of {@link PermissionsBitField}
-   * * An Array of PermissionResolvable
-   * @typedef {string|bigint|PermissionsBitField|PermissionResolvable[]} PermissionResolvable
-   */
+  
 
-  /**
-   * Gets all given bits that are missing from the bitfield.
-   * @param {BitFieldResolvable} bits Bit(s) to check for
-   * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override
-   * @returns {string[]}
-   */
+  
   missing(bits, checkAdmin = true) {
     return checkAdmin && this.has(PermissionFlagsBits.Administrator) ? [] : super.missing(bits);
   }
 
-  /**
-   * Checks whether the bitfield has a permission, or any of multiple permissions.
-   * @param {PermissionResolvable} permission Permission(s) to check for
-   * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override
-   * @returns {boolean}
-   */
+  
   any(permission, checkAdmin = true) {
     return (checkAdmin && super.has(PermissionFlagsBits.Administrator)) || super.any(permission);
   }
 
-  /**
-   * Checks whether the bitfield has a permission, or multiple permissions.
-   * @param {PermissionResolvable} permission Permission(s) to check for
-   * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override
-   * @returns {boolean}
-   */
+  
   has(permission, checkAdmin = true) {
     return (checkAdmin && super.has(PermissionFlagsBits.Administrator)) || super.has(permission);
   }
 
-  /**
-   * Gets an {@link Array} of bitfield names based on the permissions available.
-   * @returns {string[]}
-   */
+  
   toArray() {
     return super.toArray(false);
   }

package/src/util/ShardEvents.js

@@ -1,21 +1,9 @@
 'use strict';
 
-/**
- * @typedef {Object} ShardEvents
- * @property {string} Death death
- * @property {string} Disconnect disconnect
- * @property {string} Error error
- * @property {string} Message message
- * @property {string} Ready ready
- * @property {string} Reconnecting reconnecting
- * @property {string} Spawn spawn
- */
 
-// JSDoc for IntelliSense purposes
-/**
- * @type {ShardEvents}
- * @ignore
- */
+
+
+
 module.exports = {
   Death: 'death',
   Disconnect: 'disconnect',

package/src/util/Status.js

@@ -2,24 +2,10 @@
 
 const { createEnum } = require('./Enums');
 
-/**
- * @typedef {Object} Status
- * @property {number} Ready
- * @property {number} Connecting
- * @property {number} Reconnecting
- * @property {number} Idle
- * @property {number} Nearly
- * @property {number} Disconnected
- * @property {number} WaitingForGuilds
- * @property {number} Identifying
- * @property {number} Resuming
- */
 
-// JSDoc for IntelliSense purposes
-/**
- * @type {Status}
- * @ignore
- */
+
+
+
 module.exports = createEnum([
   'Ready',
   'Connecting',