ClientOptions
Defined in: packages/types/src/gateway.ts:118
Client configuration.
Properties
Section titled “Properties”allowedMentions?
Section titled “allowedMentions?”
optionalallowedMentions?:AllowedMentions
Defined in: packages/types/src/gateway.ts:154
Default allowed_mentions for every message the client sends (channel
send/edit, replies, interaction replies, edits and follow-ups), e.g.
{ parse: [] } so nothing pings unless a message says so. A message’s
own allowed_mentions always wins.
cache?
Section titled “cache?”
optionalcache?:object
Defined in: packages/types/src/gateway.ts:136
Which resources the client keeps from Gateway events. Everything is cached by default; large bots can turn off what they do not read. Events are still emitted either way.
emojis?
Section titled “emojis?”
optionalemojis?:boolean
maxMembers?
Section titled “maxMembers?”
optionalmaxMembers?:number
Most members kept per guild (least recently used leave first). Default: unbounded, so a big guild’s member list stays whole.
maxUsers?
Section titled “maxUsers?”
optionalmaxUsers?:number
Most users kept in client.users (least recently used leave first). Default: unbounded.
members?
Section titled “members?”
optionalmembers?:boolean
presences?
Section titled “presences?”
optionalpresences?:boolean
Keep each member’s latest presence (needs the GuildPresences intent). Off by default: it is a lot of data.
roles?
Section titled “roles?”
optionalroles?:boolean
users?
Section titled “users?”
optionalusers?:boolean
compress?
Section titled “compress?”
optionalcompress?:boolean
Defined in: packages/types/src/gateway.ts:127
zlib-stream transport compression for the Gateway connection, about a
tenth of the inbound bandwidth. Shorthand for gateway: { compress },
which wins when both are set. Off by default.
gateway?
Section titled “gateway?”
optionalgateway?:GatewayOptions
Defined in: packages/types/src/gateway.ts:121
intents
Section titled “intents”intents:
GatewayIntentResolvable
Defined in: packages/types/src/gateway.ts:120
messageCache?
Section titled “messageCache?”
optionalmessageCache?:object
Defined in: packages/types/src/gateway.ts:130
Opt-in bounded per-channel message cache. Messages are not cached by default.
maxSize?
Section titled “maxSize?”
optionalmaxSize?:number
optionalttl?:number
optionalrest?:RESTOptions
Defined in: packages/types/src/gateway.ts:128
token:
string
Defined in: packages/types/src/gateway.ts:119