Interface ClientOptions

interface ClientOptions {
    allowedMentions?: AllowedMentions;
    auth?: null | string;
    collectionLimits?: CollectionLimitsOptions;
    defaultImageFormat?: "jpg" | "jpeg" | "png" | "webp" | "gif";
    defaultImageSize?: number;
    disableCache?: boolean | "no-warning";
    disableMemberLimitScaling?: boolean;
    gateway?: GatewayOptions;
    rest?: RESTOptions;
}

Properties

allowedMentions? auth? collectionLimits? defaultImageFormat? defaultImageSize? disableCache? disableMemberLimitScaling? gateway? rest?

Properties

Optional allowedMentions

allowedMentions?: AllowedMentions

The default allowed mentions object.

Default Value

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

Optional auth

auth?: null | string

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

Optional collectionLimits

collectionLimits?: CollectionLimitsOptions

The maximum number of items that can be present in various collections.

Optional defaultImageFormat

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

The default image format to use.

Default Value

png

Optional defaultImageSize

defaultImageSize?: number

The default image size to use.

Default Value

4096

Optional disableCache

disableCache?: boolean | "no-warning"

Enable to disable as much caching as reasonably possible. You should only enable this option if you absolutely know what you are doing. This will break many features that rely on caching. Unless set to the literal string "no-warning", this will emit a node warning (via process.emitWarning) when the client is constructed.

Default Value

false

Optional 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

Optional gateway

gateway?: GatewayOptions

The gateway options.

Optional rest

rest?: RESTOptions

The options for the request handler.

Settings

Member Visibility

Theme

On This Page

allowedMentionsauthcollectionLimitsdefaultImageFormatdefaultImageSizedisableCachedisableMemberLimitScalinggatewayrest