CreateGatewayManagerOptions
Documentation / @discordeno/bot / CreateGatewayManagerOptions
Interface: CreateGatewayManagerOptions
Defined in: packages/gateway/dist/types/manager.d.ts:6
Properties
cache?
optionalcache:object
Defined in: packages/gateway/dist/types/manager.d.ts:89
This managers cache related settings.
requestMembers?
optionalrequestMembers:object
requestMembers.enabled?
optionalrequestMembers.enabled:boolean
Whether or not request member requests should be cached.
Default
false
compress?
optionalcompress:boolean
Defined in: packages/gateway/dist/types/manager.d.ts:48
Whether incoming payloads are compressed using zlib.
Default
false
connection?
optionalconnection:object
Defined in: packages/gateway/dist/types/manager.d.ts:43
Important data which is used by the manager to connect shards to the gateway.
sessionStartLimit
sessionStartLimit:
object
sessionStartLimit.maxConcurrency
sessionStartLimit.maxConcurrency:
number
sessionStartLimit.remaining
sessionStartLimit.remaining:
number
sessionStartLimit.resetAfter
sessionStartLimit.resetAfter:
number
sessionStartLimit.total
sessionStartLimit.total:
number
shards
shards:
number
url
url:
string
events?
optionalevents:ShardEvents
Defined in: packages/gateway/dist/types/manager.d.ts:87
The events handlers
firstShardId?
optionalfirstShardId:number
Defined in: packages/gateway/dist/types/manager.d.ts:11
Id of the first Shard which should get controlled by this manager.
Default
0
intents?
optionalintents:number
Defined in: packages/gateway/dist/types/manager.d.ts:55
The calculated intent value of the events which the shard should receive.
Default
0
lastShardId?
optionallastShardId:number
Defined in: packages/gateway/dist/types/manager.d.ts:16
Id of the last Shard which should get controlled by this manager.
Default
0
logger?
optionallogger:Pick<{debug: (...args) =>void;error: (...args) =>void;fatal: (...args) =>void;info: (...args) =>void;log: (level, ...args) =>void;setDepth: (level) =>void;setLevel: (level) =>void;warn: (...args) =>void; },"debug"|"info"|"warn"|"error"|"fatal">
Defined in: packages/gateway/dist/types/manager.d.ts:102
The logger that the gateway manager will use.
Default
logger // The logger exported by @discordeno/utils
makePresence()?
optionalmakePresence: () =>Promise<undefined|BotStatusUpdate>
Defined in: packages/gateway/dist/types/manager.d.ts:109
Make the presence for when the bot connects to the gateway
Returns
Promise<undefined | BotStatusUpdate>
Remarks
This function will be called each time a Shard is going to identify
preferSnakeCase?
optionalpreferSnakeCase:boolean
Defined in: packages/gateway/dist/types/manager.d.ts:26
Whether to send the discord packets in snake case form.
Default
false
properties?
optionalproperties:object
Defined in: packages/gateway/dist/types/manager.d.ts:57
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"
resharding?
optionalresharding:object
Defined in: packages/gateway/dist/types/manager.d.ts:111
Options related to resharding.
checkInterval
checkInterval:
number
The interval in milliseconds, of how often to check whether resharding is needed and reshard automatically. Set to -1 to disable auto resharding.
Default
28800000 (8 hours)
enabled
enabled:
boolean
Whether or not automated resharding should be enabled.
Default
true
getSessionInfo()?
optionalgetSessionInfo: () =>Promise<{sessionStartLimit: {maxConcurrency:number;remaining:number;resetAfter:number;total:number; };shards:number;url:string; }>
Handler to get shard count and other session info.
Returns
Promise<{ sessionStartLimit: { maxConcurrency: number; remaining: number; resetAfter: number; total: number; }; shards: number; url: string; }>
shardsFullPercentage
shardsFullPercentage:
number
The % of how full a shard is when resharding should be triggered.
Remarks
We use discord recommended shard value to get an approximation of the shard full percentage to compare with this value so the bot may not reshard at the exact percentage provided but may reshard when it is a bit higher than the provided percentage.
For accurate calculation, you may override the checkIfReshardingIsNeeded function
Default
80 as in 80%
updateGuildsShardId()?
optionalupdateGuildsShardId: (guildIds,shardId) =>Promise<void>
Handler to edit the shard id on any cached guilds.
Parameters
guildIds
string[]
shardId
number
Returns
Promise<void>
shardsPerWorker?
optionalshardsPerWorker:number
Defined in: packages/gateway/dist/types/manager.d.ts:36
The amount of shards to load per worker.
Default
25
spawnShardDelay?
optionalspawnShardDelay:number
Defined in: packages/gateway/dist/types/manager.d.ts:21
Delay in milliseconds to wait before spawning next shard. OPTIMAL IS ABOVE 5100. YOU DON'T WANT TO HIT THE RATE LIMIT!!!
Default
5300
token
token:
string
Defined in: packages/gateway/dist/types/manager.d.ts:75
Bot token which is used to connect to Discord
totalShards?
optionaltotalShards:number
Defined in: packages/gateway/dist/types/manager.d.ts:31
Total amount of shards your bot uses. Useful for zero-downtime updates or resharding.
Default
1
totalWorkers?
optionaltotalWorkers:number
Defined in: packages/gateway/dist/types/manager.d.ts:41
The total amount of workers to use for your bot.
Default
4
transportCompression?
optionaltransportCompression:null|TransportCompression
Defined in: packages/gateway/dist/types/manager.d.ts:50
What transport compression should be used
url?
optionalurl:string
Defined in: packages/gateway/dist/types/manager.d.ts:80
The URL of the gateway which should be connected to.
Default
"wss://gateway.discord.gg"
version?
optionalversion:number
Defined in: packages/gateway/dist/types/manager.d.ts:85
The gateway version which should be used.
Default
10