Skip to content

ClientOptions

Defined in: packages/types/src/gateway.ts:118

Client configuration.

optional allowedMentions?: 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.


optional cache?: 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.

optional emojis?: boolean

optional maxMembers?: number

Most members kept per guild (least recently used leave first). Default: unbounded, so a big guild’s member list stays whole.

optional maxUsers?: number

Most users kept in client.users (least recently used leave first). Default: unbounded.

optional members?: boolean

optional presences?: boolean

Keep each member’s latest presence (needs the GuildPresences intent). Off by default: it is a lot of data.

optional roles?: boolean

optional users?: boolean


optional compress?: 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.


optional gateway?: GatewayOptions

Defined in: packages/types/src/gateway.ts:121


intents: GatewayIntentResolvable

Defined in: packages/types/src/gateway.ts:120


optional messageCache?: object

Defined in: packages/types/src/gateway.ts:130

Opt-in bounded per-channel message cache. Messages are not cached by default.

optional maxSize?: number

optional ttl?: number


optional rest?: RESTOptions

Defined in: packages/types/src/gateway.ts:128


token: string

Defined in: packages/types/src/gateway.ts:119