Watcher

Represents a watcher class that extends the ShardManager.

Extends

• ShardManager

Constructors

new Watcher(options)

new Watcher(options: WatcherOptions): Watcher

Initializes a new instance of the Watcher class.

Parameters

Parameter	Type	Description
options	WatcherOptions	The options for the watcher.

Returns

Watcher

Overrides

ShardManager.constructor

Source

seyfert/src/common/bot/watcher.ts:27

Properties

Property	Modifier	Type	Description	Overrides	Inherited from
[toStringTag]	readonly	string	-	ShardManager.[toStringTag]	ShardManager.[toStringTag]
connectQueue	public	ConnectQueue	-	ShardManager.connectQueue	ShardManager.connectQueue
debugger?	public	Logger	-	ShardManager.debugger	ShardManager.debugger
logger	public	Logger	-	-	-
options	public	MakeRequired<WatcherOptions, "token" | "intents" | "info" | "handlePayload">	-	ShardManager.options	ShardManager.options
rest?	public	ApiHandler	-	-	-
size	readonly	number		ShardManager.size	ShardManager.size
worker?	public	Worker	-	-	-
[species]	readonly	MapConstructor	-	ShardManager.[species]	ShardManager.[species]

Accessors

concurrency

get concurrency(): number

Returns

number

Source

seyfert/src/websocket/discord/sharder.ts:57

---

latency

get latency(): number

Returns

number

Source

seyfert/src/websocket/discord/sharder.ts:61

---

remaining

get remaining(): number

Returns

number

Source

seyfert/src/websocket/discord/sharder.ts:53

---

shardEnd

get shardEnd(): number

Returns

number

Source

seyfert/src/websocket/discord/sharder.ts:49

---

shardStart

get shardStart(): number

Returns

number

Source

seyfert/src/websocket/discord/sharder.ts:45

---

totalShards

get totalShards(): number

Returns

number

Source

seyfert/src/websocket/discord/sharder.ts:41

Methods

[iterator]()

iterator: IterableIterator<[number, Shard]>

Returns an iterable of entries in the map.

Returns

IterableIterator<[number, Shard]>

Inherited from

ShardManager.[iterator]

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

---

calculateShardId()

calculateShardId(guildId: string): number

Parameters

Parameter	Type
guildId	string

Returns

number

Inherited from

ShardManager.calculateShardId

Source

seyfert/src/websocket/discord/sharder.ts:69

---

clear()

clear(): void

Returns

void

Inherited from

ShardManager.clear

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.collection.d.ts:20

---

delete()

delete(key: number): boolean

Parameters

Parameter	Type
key	number

Returns

boolean

true if an element in the Map existed and has been removed, or false if the element does not exist.

Inherited from

ShardManager.delete

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

---

disconnect()

disconnect(shardId: number): undefined | Promise<void>

Parameters

Parameter	Type
shardId	number

Returns

undefined | Promise<void>

Inherited from

ShardManager.disconnect

Source

seyfert/src/websocket/discord/sharder.ts:130

---

disconnectAll()

disconnectAll(): Promise<unknown>

Returns

Promise<unknown>

Inherited from

ShardManager.disconnectAll

Source

seyfert/src/websocket/discord/sharder.ts:135

---

entries()

entries(): IterableIterator<[number, Shard]>

Returns an iterable of key, value pairs for every entry in the map.

Returns

IterableIterator<[number, Shard]>

Inherited from

ShardManager.entries

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

---

forEach()

forEach(callbackfn:     (value: Shard, key: number, map: Map<number, Shard>) => void, thisArg?: any): void

Executes a provided function once per each key/value pair in the Map, in insertion order.

Parameters

Parameter	Type
callbackfn	(value: Shard, key: number, map: Map<number, Shard>) => void
thisArg?	any

Returns

void

Inherited from

ShardManager.forEach

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

---

forceIdentify()

forceIdentify(shardId: number): Promise<void>

Parameters

Parameter	Type
shardId	number

Returns

Promise<void>

Inherited from

ShardManager.forceIdentify

Source

seyfert/src/websocket/discord/sharder.ts:125

---

get()

get(key: number): undefined | Shard

Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

Parameters

Parameter	Type
key	number

Returns

undefined | Shard

Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

Inherited from

ShardManager.get

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.collection.d.ts:33

---

has()

has(key: number): boolean

Parameters

Parameter	Type
key	number

Returns

boolean

boolean indicating whether an element with the specified key exists or not.

Inherited from

ShardManager.has

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.collection.d.ts:37

---

joinVoice()

joinVoice(
   guild_id: string,
   channel_id: string,
   options:     Object): void

Parameters

Parameter	Type
guild_id	string
channel_id	string
options	Object
options.selfDeaf	boolean
options.selfMute	boolean

Returns

void

Inherited from

ShardManager.joinVoice

Source

seyfert/src/websocket/discord/sharder.ts:160

---

keys()

keys(): IterableIterator<number>

Returns an iterable of keys in the map

Returns

IterableIterator<number>

Inherited from

ShardManager.keys

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

---

leaveVoice()

leaveVoice(guild_id: string): void

Parameters

Parameter	Type
guild_id	string

Returns

void

Inherited from

ShardManager.leaveVoice

Source

seyfert/src/websocket/discord/sharder.ts:178

---

resetWorker()

resetWorker(): void

Resets the worker instance.

Returns

void

Source

seyfert/src/common/bot/watcher.ts:49

---

send()

send<T>(shardId: number, payload: T): void

Type parameters

Type parameter
T extends GatewaySendPayload

Parameters

Parameter	Type
shardId	number
payload	T

Returns

void

Inherited from

ShardManager.send

Source

seyfert/src/websocket/discord/sharder.ts:193

---

set()

set(key: number, value: Shard): this

Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

Parameters

Parameter	Type
key	number
value	Shard

Returns

this

Inherited from

ShardManager.set

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.collection.d.ts:41

---

setPresence()

setPresence(payload: GatewayPresenceUpdateData): Promise<void>

Parameters

Parameter	Type
payload	GatewayPresenceUpdateData

Returns

Promise<void>

Inherited from

ShardManager.setPresence

Source

seyfert/src/websocket/discord/sharder.ts:151

---

setShardPresence()

setShardPresence(shardId: number, payload: GatewayPresenceUpdateData): void

Parameters

Parameter	Type
shardId	number
payload	GatewayPresenceUpdateData

Returns

void

Inherited from

ShardManager.setShardPresence

Source

seyfert/src/websocket/discord/sharder.ts:143

---

spawn()

spawn(shardId: number): Shard

Parameters

Parameter	Type
shardId	number

Returns

Shard

Inherited from

ShardManager.spawn

Source

seyfert/src/websocket/discord/sharder.ts:73

---

spawnBuckets()

spawnBuckets(): Shard[][]

Returns

Shard[][]

Inherited from

ShardManager.spawnBuckets

Source

seyfert/src/websocket/discord/sharder.ts:112

---

spawnShards()

spawnShards(): Promise<void>

Spawns shards for the watcher.

Returns

Promise<void>

Overrides

ShardManager.spawnShards

Source

seyfert/src/common/bot/watcher.ts:72

---

values()

values(): IterableIterator<Shard>

Returns an iterable of values in the map

Returns

IterableIterator<Shard>

Inherited from

ShardManager.values

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

---

groupBy()

static groupBy<K, T>(items: Iterable<T>, keySelector:     (item: T, index: number) => K): Map<K, T[]>

Groups members of an iterable according to the return value of the passed callback.

Type parameters

Type parameter
K
T

Parameters

Parameter	Type	Description
items	Iterable<T>	An iterable.
keySelector	(item: T, index: number) => K	A callback which will be invoked for each item in items.

Returns

Map<K, T[]>

Inherited from

ShardManager.groupBy

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.esnext.collection.d.ts:25