Interface

ClientOptions

Configuration options for Client.

Properties

cache?: CacheSizeLimits

Cache size limits per bucket. Defaults to DEFAULT_CACHE_LIMITS. Pass `0` / `Infinity` per numeric field for unbounded; `messages: false` to disable message caching.

defaultAllowedMentions?: { parse?: Array<"roles" | "users" | "everyone">; roles?: string[]; users?: string[]; repliedUser?: boolean; }

Default allowed mentions when a send omits them (per-call wins).

defaultReplyPing?: boolean

Default reply ping for `message.reply` when `ping` is omitted.

gatewayDebug?: boolean

Emit gateway debug strings.

gatewayDeferHandlers?: boolean

Defer dispatch handlers to the next macrotask so WS `message` stays responsive.

identifyFlags?: number

GatewayIdentifyFlags bitfield sent as Identify `flags`.

ignoredEvents?: string[]

Dispatch event names to suppress for this session (`ignored_events`).

initialGuildId?: string

Prefer hydrating this guild first after READY (`initial_guild_id`).

instance?: Partial<APIInstanceEndpoints> | APIInstance

Instance endpoints for this client (API, CDN, invite, etc.). Pass a partial map to override hosted defaults, or a full discovery document. Prefer this over `rest.api` for multi-instance / self-hosted bots.

intents?: number

Gateway intents (Fluxer currently always sends `0`). Reserved for future use.

logger?: Logger

Custom logger instance (overrides logLevel sink defaults).

logLevel?: LogLevel

Minimum log level for Client. Default: `warn`.

presence?: GatewayPresenceUpdateData

Initial presence on identify (also updatable via `client.user.setPresence`).

rest?: Partial<ConstructorParameters<typeof REST>[]>

REST options. Prefer ClientOptions for the API host. If both `instance.api` (or resolved default) and `rest.api` are set and differ, construction throws.

suppressIntentWarning?: boolean

Silence the intents-not-supported warning.

waitForGuilds?: boolean

Delay Ready until all READY guilds arrive via GUILD_CREATE; queue other dispatches until then.

WebSocket

?: new (url: string) => { send(data: string | ArrayBufferLike): void; close(code?: number): void; readyState: number; addEventListener?(type: string, listener: (e: unknown) => void): void; on?(event: string, cb: (data?: unknown) => void): void; }

Optional WebSocket constructor (e.g. `ws` in Node). Provide if the runtime lacks a native WebSocket implementation.