Interface CollectionLimitsOptions

Changing many of these may have the side effect of silently breaking various functionalities. Most of these are not intended to be changed, and are only exposed for advanced use cases.

For the options which accept a number and an object:

  • number: applies for all instances in which the limit would apply
  • object: dictionary of ids to limits. When setting limits, if the id is present, the specific number listed with that id will be used. Else, the default key will be used. If the default key is not present, whatever the default for that specific option is will be used.

See the Dictionary Key header for each option for what the id refers to.

interface CollectionLimitsOptions {
    auditLogEntries?: number | Record<string, number>;
    autoModerationRules?: number | Record<string, number>;
    channels?: number | Record<string, number>;
    emojis?: number | Record<string, number>;
    groupChannels?: number;
    guildThreads?: number | Record<string, number>;
    guilds?: number;
    integrations?: number | Record<string, number>;
    invites?: number | Record<string, number>;
    members?: number | Record<string, number>;
    messages?: number | Record<string, number>;
    privateChannels?: number;
    roles?: number | Record<string, number>;
    scheduledEvents?: number | Record<string, number>;
    soundboardSounds?: number | Record<string, number>;
    stageInstances?: number | Record<string, number>;
    stickers?: number | Record<string, number>;
    unavailableGuilds?: number;
    users?: number;
    voiceMembers?: number | Record<string, number>;
    voiceStates?: number | Record<string, number>;
}

Properties

auditLogEntries? autoModerationRules? channels? emojis? groupChannels? guildThreads? guilds? integrations? invites? members? messages? privateChannels? roles? scheduledEvents? soundboardSounds? stageInstances? stickers? unavailableGuilds? users? voiceMembers? voiceStates?

Properties

Optional auditLogEntries

auditLogEntries?: number | Record<string, number>

The maximum number of audit log entries to keep cached. Entries are only cached if recieved via the GUILD_AUDIT_LOG_ENTRY_CREATE gateway event.

Dictionary Key

guild id

Default Value

50

Optional autoModerationRules

autoModerationRules?: number | Record<string, number>

The maximum number of auto moderation rules to keep cached. Entries are only cached if fetched via REST, or recieved via the AUTO_MODERATION_RULE_CREATE/AUTO_MODERATION_RULE_UPDATE events.

Dictionary Key

guild id

Default Value

Infinity

Optional channels

channels?: number | Record<string, number>

The maximum number of guild channels to cache.

Dictionary Key

guild id

Default Value

Infinity

Optional emojis

emojis?: number | Record<string, number>

The maximum number of guild emojis to cache.

Dictionary Key

guild id

Default Value

Infinity

Optional groupChannels

groupChannels?: number

The maximum number of group channels to cache.

Default Value

10

Optional guildThreads

guildThreads?: number | Record<string, number>

The maximum number of threads to cache per guild. Setting this too low might cause channels to have missing threads, as they all pull from the guild.

Dictionary Key

guild id

Default Value

Infinity

Optional guilds

guilds?: number

The maximum number of guilds to cache.

Default Value

Infinity

Note

Changing this WILL silently break a lot of things which rely on caching.

Optional integrations

integrations?: number | Record<string, number>

The maximum number of guild integrations to cache.

Dictionary Key

guild id

Default Value

Infinity

Optional invites

invites?: number | Record<string, number>

The maximum number of guild invites to cache.

Dictionary Key

guild id

Default Value

Infinity

Optional members

members?: number | Record<string, number>

The maximum number of members to cache.

Note: If you request members from the gateway, this will be increased (on the specific guild) as needed to accommodate those members.

Dictionary Key

guild id

Default Value

Infinity

Optional messages

messages?: number | Record<string, number>

The maximum number of messages to cache.

Dictionary Key

channel id

Default Value

100

Optional privateChannels

privateChannels?: number

The maximum number of private channels to cache.

Default Value

25

Optional roles

roles?: number | Record<string, number>

The maximum number of roles to cache.

Dictionary Key

guild id

Default Value

Infinity

Optional scheduledEvents

scheduledEvents?: number | Record<string, number>

The maximum number of scheduled events to cache.

Dictionary Key

guild id

Default Value

Infinity

Optional soundboardSounds

soundboardSounds?: number | Record<string, number>

The maximum number of soundboard sounds to cache.

Dictionary Key

guild id

Default Value

Infinity

Optional stageInstances

stageInstances?: number | Record<string, number>

The maximum number of stage instances to cache.

Dictionary Key

guild id

Default Value

Infinity

Optional stickers

stickers?: number | Record<string, number>

The maximum number of guild stickers to cache.

Dictionary Key

guild id

Default Value

Infinity

Optional unavailableGuilds

unavailableGuilds?: number

The maximum number of unavailable guilds to cache.

Default Value

Infinity

Note

Changing this WILL break many things. The client may not even ready poperly.

Optional users

users?: number

The maximum number of users to cache globally.

Default Value

Infinity

Optional voiceMembers

voiceMembers?: number | Record<string, number>

The maximum number of voice members to cache.

Dictionary Key

guild id

Default Value

Infinity

Optional voiceStates

voiceStates?: number | Record<string, number>

The maximum number of voice states to cache.

Dictionary Key

guild id

Default Value

Infinity

Settings

Member Visibility

Theme

On This Page

auditLogEntriesautoModerationRuleschannelsemojisgroupChannelsguildThreadsguildsintegrationsinvitesmembersmessagesprivateChannelsrolesscheduledEventssoundboardSoundsstageInstancesstickersunavailableGuildsusersvoiceMembersvoiceStates