Interface ClientInstanceOptions

interface ClientInstanceOptions {
    allowedMentions: AllowedMentions;
    auth: null | string;
    collectionLimits: Required<CollectionLimitsOptions>;
    defaultImageFormat: "jpg" | "jpeg" | "png" | "webp" | "gif";
    defaultImageSize: number;
    disableCache: boolean;
    disableMemberLimitScaling: boolean;
    restMode: boolean;
}

Hierarchy

Properties

allowedMentions auth collectionLimits defaultImageFormat defaultImageSize disableCache disableMemberLimitScaling restMode

Properties

allowedMentions

allowedMentions: AllowedMentions

The default allowed mentions object.

Default Value

{ everyone: false, repliedUser: false, roles: true, users: true }

auth

auth: null | string

Fully qualified authorization string (e.x. Bot [TOKEN]) - you MUST prefix it yourself

collectionLimits

collectionLimits: Required<CollectionLimitsOptions>

defaultImageFormat

defaultImageFormat: "jpg" | "jpeg" | "png" | "webp" | "gif"

The default image format to use.

Default Value

png

defaultImageSize

defaultImageSize: number

The default image size to use.

Default Value

4096

disableCache

disableCache: boolean

disableMemberLimitScaling

disableMemberLimitScaling: boolean

When member limits are set on guilds, the limit is automatically raised if needed when requesting members from the gateway. This can be buggy and may not function correctly.

Default Value

false

restMode

restMode: boolean

If rest mode has been enabled.

Settings

Member Visibility

Theme

On This Page

allowedMentionsauthcollectionLimitsdefaultImageFormatdefaultImageSizedisableCachedisableMemberLimitScalingrestMode