Skip to main content

ShardGatewayConfig

Documentation

Documentation / @discordeno/gateway / ShardGatewayConfig

Interface: ShardGatewayConfig

Defined in: gateway/src/types.ts:44

Properties​

compress​

compress: boolean

Defined in: gateway/src/types.ts:55

Whatever to enable Payload compression.

Remarks​

This is compatible with transportCompression

Default​

false

See​

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

intents​

intents: number

Defined in: gateway/src/types.ts:68

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

Default​

0

properties​

properties: object

Defined in: gateway/src/types.ts:70

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"

token​

token: string

Defined in: gateway/src/types.ts:88

Bot token which is used to connect to Discord

totalShards​

totalShards: number

Defined in: gateway/src/types.ts:103

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

Default​

1

transportCompression​

transportCompression: null | TransportCompression

Defined in: gateway/src/types.ts:63

What Transport Compression should be use

Default​

null

See​

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

url​

url: string

Defined in: gateway/src/types.ts:93

The URL of the gateway which should be connected to.

Default​

"wss://gateway.discord.gg"

version​

version: number

Defined in: gateway/src/types.ts:98

The gateway version which should be used.

Default​

10