mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-15 11:03:30 +01:00
Update sharding docs some more
This commit is contained in:
@@ -6,7 +6,9 @@ const { Error } = require('../errors');
|
|||||||
const delayFor = require('util').promisify(setTimeout);
|
const delayFor = require('util').promisify(setTimeout);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A self-contained shard spawned by the {@link ShardingManager}.
|
* A self-contained shard created by the {@link ShardingManager}. Each one has a {@link ChildProcess} that contains
|
||||||
|
* an instance of the bot and its {@link Client}. When its child process exits for any reason, the shard will spawn a
|
||||||
|
* new one to replace it as necessary.
|
||||||
* @extends EventEmitter
|
* @extends EventEmitter
|
||||||
*/
|
*/
|
||||||
class Shard extends EventEmitter {
|
class Shard extends EventEmitter {
|
||||||
|
|||||||
@@ -9,11 +9,11 @@ const delayFor = require('util').promisify(setTimeout);
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* This is a utility class that makes multi-process sharding of a bot an easy and painless experience.
|
* This is a utility class that makes multi-process sharding of a bot an easy and painless experience.
|
||||||
* It works by spawning a self-contained {@link ChildProcess} for each individual shard, each containing its own client.
|
* It works by spawning a self-contained {@link ChildProcess} for each individual shard, each containing its own
|
||||||
* They all have a line of communication with the master process, and there are several useful methods that utilise
|
* instance of your bot's {@link Client}. They all have a line of communication with the master process, and there are
|
||||||
* it in order to simplify tasks that are normally difficult with multi-process sharding. It can spawn a specific number
|
* several useful methods that utilise it in order to simplify tasks that are normally difficult with sharding. It can
|
||||||
* of shards or the amount that Discord suggests for the bot, and takes a path to your main bot script to launch for
|
* spawn a specific number of shards or the amount that Discord suggests for the bot, and takes a path to your main bot
|
||||||
* each one.
|
* script to launch for each one.
|
||||||
* @extends {EventEmitter}
|
* @extends {EventEmitter}
|
||||||
*/
|
*/
|
||||||
class ShardingManager extends EventEmitter {
|
class ShardingManager extends EventEmitter {
|
||||||
|
|||||||
Reference in New Issue
Block a user