CreateGatewayManagerOptions
@discordeno/gateway • Docs
Documentation / @discordeno/gateway / CreateGatewayManagerOptions
Interface: CreateGatewayManagerOptions
Properties
cache?
optionalcache:object
This managers cache related settings.
requestMembers?
optionalrequestMembers:object
requestMembers.enabled?
optionalrequestMembers.enabled:boolean
Whether or not request member requests should be cached.
Default
false
Defined in
compress?
optionalcompress:boolean
Whether incoming payloads are compressed using zlib.
Default
false
Defined in
connection?
optionalconnection:object
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
Defined in
events?
optionalevents:ShardEvents
The events handlers
Defined in
firstShardId?
optionalfirstShardId:number
Id of the first Shard which should get controlled by this manager.
Default
0
Defined in
intents?
optionalintents:number
The calculated intent value of the events which the shard should receive.
Default
0
Defined in
lastShardId?
optionallastShardId:number
Id of the last Shard which should get controlled by this manager.
Default
0
Defined in
logger?
optionallogger:Pick<object,"debug"|"info"|"warn"|"error"|"fatal">
The logger that the gateway manager will use.
Type declaration
debug()
debug: (...
args) =>void
Parameters
• ...args: any[]
Returns
void
error()
error: (...
args) =>void
Parameters
• ...args: any[]
Returns
void
fatal()
fatal: (...
args) =>void
Parameters
• ...args: any[]
Returns
void
info()
info: (...
args) =>void
Parameters
• ...args: any[]
Returns
void
log()
log: (
level, ...args) =>void
Parameters
• level: LogLevels
• ...args: any[]
Returns
void
setDepth()
setDepth: (
level) =>void
Parameters
• level: LogDepth
Returns
void
setLevel()
setLevel: (
level) =>void
Parameters
• level: LogLevels
Returns
void
warn()
warn: (...
args) =>void
Parameters
• ...args: any[]
Returns
void
Default
logger // The logger exported by @discordeno/utils
Defined in
makePresence()?
optionalmakePresence: () =>Promise<undefined|BotStatusUpdate>
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
Defined in
preferSnakeCase?
optionalpreferSnakeCase:boolean
Whether to send the discord packets in snake case form.
Default
false
Defined in
properties?
optionalproperties: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
resharding?
optionalresharding:object
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<object>
Handler to get shard count and other session info.
Returns
Promise<object>
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
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>
Defined in
shardsPerWorker?
optionalshardsPerWorker:number
The amount of shards to load per worker.
Default
25
Defined in
spawnShardDelay?
optionalspawnShardDelay:number
Delay in milliseconds to wait before spawning next shard. OPTIMAL IS ABOVE 5100. YOU DON'T WANT TO HIT THE RATE LIMIT!!!
Default
5300
Defined in
token
token:
string
Bot token which is used to connect to Discord
Defined in
totalShards?
optionaltotalShards:number
Total amount of shards your bot uses. Useful for zero-downtime updates or resharding.
Default
1
Defined in
totalWorkers?
optionaltotalWorkers:number
The total amount of workers to use for your bot.
Default
4
Defined in
transportCompression?
optionaltransportCompression:null|TransportCompression
What transport compression should be used
Defined in
url?
optionalurl:string
The URL of the gateway which should be connected to.
Default
"wss://gateway.discord.gg"
Defined in
version?
optionalversion:number
The gateway version which should be used.
Default
10