Class WorkerBootstrapper

Utility class for bootstrapping a worker thread to be used for sharding

Hierarchy

WorkerBootstrapper

Index

Constructors

Properties

Methods

bootstrap connect destroy setupThreadEvents

Constructors

constructor

new WorkerBootstrapper(): WorkerBootstrapper
Returns WorkerBootstrapper
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:679

Properties

`Protected` `Readonly` data

data: WorkerData

The data passed to the worker thread

`Protected` `Readonly` shards

shards: Collection<number, WebSocketShard>

The shards that are managed by this worker

Methods

bootstrap

bootstrap(options?): Promise<void>
Bootstraps the worker thread with the provided options
Parameters
- Optional options: Readonly<BootstrapOptions>
Returns Promise<void>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:695

`Protected` connect

connect(shardId): Promise<void>
Helper method to initiate a shard's connection process
Parameters
- shardId: number
Returns Promise<void>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:683

`Protected` destroy

destroy(shardId, options?): Promise<void>
Helper method to destroy a shard
Parameters
- shardId: number
- Optional options: WebSocketShardDestroyOptions
Returns Promise<void>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:687

`Protected` setupThreadEvents

setupThreadEvents(): void
Helper method to attach event listeners to the parentPort

Returns void
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:691

Generated using TypeDoc