refactor(Util)!: rename fetchRecommendedShards (#8298)

discordjs · Jul 17, 2022 · cafde77 · cafde77
1 parent b7d4e55
commit cafde77
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/packages/discord.js/src/sharding/ShardingManager.js b/packages/discord.js/src/sharding/ShardingManager.js
@@ -8,7 +8,7 @@ const { setTimeout: sleep } = require('node:timers/promises');
 const { Collection } = require('@discordjs/collection');
 const Shard = require('./Shard');
 const { Error, TypeError, RangeError, ErrorCodes } = require('../errors');
-const { mergeDefault, fetchRecommendedShards } = require('../util/Util');
+const { mergeDefault, fetchRecommendedShardCount } = require('../util/Util');
 
 /**
  * This is a utility class that makes multi-process sharding of a bot an easy and painless experience.
@@ -187,7 +187,7 @@ class ShardingManager extends EventEmitter {
   async spawn({ amount = this.totalShards, delay = 5500, timeout = 30_000 } = {}) {
     // Obtain/verify the number of shards to spawn
     if (amount === 'auto') {
-      amount = await fetchRecommendedShards(this.token);
+      amount = await fetchRecommendedShardCount(this.token);
     } else {
       if (typeof amount !== 'number' || isNaN(amount)) {
         throw new TypeError(ErrorCodes.ClientInvalidOption, 'Amount of shards', 'a number.');

diff --git a/packages/discord.js/src/util/Util.js b/packages/discord.js/src/util/Util.js
@@ -211,18 +211,18 @@ function escapeSpoiler(text) {
 }
 
 /**
- * @typedef {Object} FetchRecommendedShardsOptions
+ * @typedef {Object} FetchRecommendedShardCountOptions
  * @property {number} [guildsPerShard=1000] Number of guilds assigned per shard
  * @property {number} [multipleOf=1] The multiple the shard count should round up to. (16 for large bot sharding)
  */
 
 /**
  * Gets the recommended shard count from Discord.
  * @param {string} token Discord auth token
- * @param {FetchRecommendedShardsOptions} [options] Options for fetching the recommended shard count
+ * @param {FetchRecommendedShardCountOptions} [options] Options for fetching the recommended shard count
  * @returns {Promise<number>} The recommended number of shards
  */
-async function fetchRecommendedShards(token, { guildsPerShard = 1_000, multipleOf = 1 } = {}) {
+async function fetchRecommendedShardCount(token, { guildsPerShard = 1_000, multipleOf = 1 } = {}) {
   if (!token) throw new DiscordError(ErrorCodes.TokenMissing);
   const response = await fetch(RouteBases.api + Routes.gatewayBot(), {
     method: 'GET',
@@ -555,7 +555,7 @@ module.exports = {
   escapeUnderline,
   escapeStrikethrough,
   escapeSpoiler,
-  fetchRecommendedShards,
+  fetchRecommendedShardCount,
   parseEmoji,
   resolvePartialEmoji,
   mergeDefault,

diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts
@@ -2290,7 +2290,7 @@ export class ShardingManager extends EventEmitter {
   public once(event: 'shardCreate', listener: (shard: Shard) => Awaitable<void>): this;
 }
 
-export interface FetchRecommendedShardsOptions {
+export interface FetchRecommendedShardCountOptions {
   guildsPerShard?: number;
   multipleOf?: number;
 }
@@ -2640,7 +2640,7 @@ export function escapeUnderline(text: string): string;
 export function escapeStrikethrough(text: string): string;
 export function escapeSpoiler(text: string): string;
 export function cleanCodeBlockContent(text: string): string;
-export function fetchRecommendedShards(token: string, options?: FetchRecommendedShardsOptions): Promise<number>;
+export function fetchRecommendedShardCount(token: string, options?: FetchRecommendedShardCountOptions): Promise<number>;
 export function flatten(obj: unknown, ...props: Record<string, boolean | string>[]): unknown;
 export function makeError(obj: MakeErrorOptions): Error;
 export function makePlainError(err: Error): MakeErrorOptions;