diff --git a/src/index.js b/src/index.js index 4ca763c..2bb897d 100644 --- a/src/index.js +++ b/src/index.js @@ -3,8 +3,11 @@ // "Root" classes (starting points) exports.BaseClient = require('./client/BaseClient'); exports.Client = require('./client/Client'); +/** @deprecated This will be removed in the next major version */ exports.Shard = require('./sharding/Shard'); +/** @deprecated This will be removed in the next major version */ exports.ShardClientUtil = require('./sharding/ShardClientUtil'); +/** @deprecated This will be removed in the next major version */ exports.ShardingManager = require('./sharding/ShardingManager'); exports.WebhookClient = require('./client/WebhookClient'); diff --git a/src/sharding/Shard.js b/src/sharding/Shard.js index fad0909..e750347 100644 --- a/src/sharding/Shard.js +++ b/src/sharding/Shard.js @@ -15,6 +15,7 @@ let Worker = null; * an instance of the bot and its {@link Client}. When its child process/worker exits for any reason, the shard will * spawn a new one to replace it as necessary. * @extends {EventEmitter} + * @deprecated */ class Shard extends EventEmitter { constructor(manager, id) { diff --git a/src/sharding/ShardClientUtil.js b/src/sharding/ShardClientUtil.js index 982d409..8a545f7 100644 --- a/src/sharding/ShardClientUtil.js +++ b/src/sharding/ShardClientUtil.js @@ -8,6 +8,7 @@ const Util = require('../util/Util'); /** * Helper class for sharded clients spawned as a child process/worker, such as from a {@link ShardingManager}. * Utilises IPC to send and receive data to/from the master process and other shards. + * @deprecated */ class ShardClientUtil { constructor(client, mode) { diff --git a/src/sharding/ShardingManager.js b/src/sharding/ShardingManager.js index 2649b77..04ff797 100644 --- a/src/sharding/ShardingManager.js +++ b/src/sharding/ShardingManager.js @@ -18,6 +18,7 @@ const Util = require('../util/Util'); * with sharding. It can spawn a specific number of shards or the amount that Discord suggests for the bot, and takes a * path to your main bot script to launch for each one. * @extends {EventEmitter} + * @deprecated */ class ShardingManager extends EventEmitter { /** diff --git a/typings/index.d.ts b/typings/index.d.ts index 0b501e3..94c82ff 100644 --- a/typings/index.d.ts +++ b/typings/index.d.ts @@ -2868,6 +2868,7 @@ export interface ShardEventTypes { message: [message: any]; } +/** @deprecated This will be removed in the next major version */ export class Shard extends EventEmitter { private constructor(manager: ShardingManager, id: number); private _evals: Map>; @@ -2906,6 +2907,7 @@ export class Shard extends EventEmitter { ): this; } +/** @deprecated This will be removed in the next major version */ export class ShardClientUtil { private constructor(client: Client, mode: ShardingManagerMode); private _handleMessage(message: unknown): void; @@ -2937,6 +2939,7 @@ export class ShardClientUtil { public static shardIdForGuildId(guildId: Snowflake, shardCount: number): number; } +/** @deprecated This will be removed in the next major version */ export class ShardingManager extends EventEmitter { public constructor(file: string, options?: ShardingManagerOptions); private _performOnShards(method: string, args: unknown[]): Promise;