ShardCreateOptions

Documentation

---

Documentation / @discordeno/gateway / ShardCreateOptions

Interface: ShardCreateOptions

Defined in: gateway/src/Shard.ts:876

Properties

connection

connection: ShardGatewayConfig

Defined in: gateway/src/Shard.ts:880

The connection details

---

events

events: ShardEvents

Defined in: gateway/src/Shard.ts:882

The event handlers for events on the shard.

---

id

id: number

Defined in: gateway/src/Shard.ts:878

The shard id

---

logger?

optional logger: Pick<{ }, "debug" | "info" | "warn" | "error" | "fatal">

Defined in: gateway/src/Shard.ts:884

The logger for the shard

---

makePresence()?

optional makePresence: () => Promise<DiscordUpdatePresence | undefined>

Defined in: gateway/src/Shard.ts:888

Function to create the bot status to send on Identify requests

Returns

Promise<DiscordUpdatePresence | undefined>

---

requestIdentify()?

optional requestIdentify: () => Promise<void>

Defined in: gateway/src/Shard.ts:886

The handler to request a space to make an identify request.

Returns

Promise<void>