Skip to main content

ShardGatewayConfig

@discordeno/gatewayDocs


Documentation / @discordeno/gateway / ShardGatewayConfig

Interface: ShardGatewayConfig

Properties

compress

compress: boolean

Whatever to enable Payload compression.

Remarks

This is compatible with transportCompression

Default

false

See

https://discord.com/developers/docs/topics/gateway#payload-compression

Defined in

gateway/src/types.ts:53


intents

intents: number

The calculated intent value of the events which the shard should receive.

Default

0

Defined in

gateway/src/types.ts:66


properties

properties: object

Identify properties to use

browser

browser: string

The "browser" where this shard is running on.

Default
"Discordeno"

device

device: string

The device on which the shard is running.

Default
"Discordeno"

os

os: string

Operating system the shard runs on.

Default
"darwin" | "linux" | "windows"

Defined in

gateway/src/types.ts:68


token

token: string

Bot token which is used to connect to Discord

Defined in

gateway/src/types.ts:86


totalShards

totalShards: number

The total number of shards to connect to across the entire bot.

Default

1

Defined in

gateway/src/types.ts:101


transportCompression

transportCompression: null | TransportCompression

What Transport Compression should be use

Default

null

See

https://discord.com/developers/docs/topics/gateway#transport-compression

Defined in

gateway/src/types.ts:61


url

url: string

The URL of the gateway which should be connected to.

Default

"wss://gateway.discord.gg"

Defined in

gateway/src/types.ts:91


version

version: number

The gateway version which should be used.

Default

10

Defined in

gateway/src/types.ts:96