Class

Client

Main Fluxer bot client. Connects to the gateway, emits events, and provides REST access.

Extends EventEmitter

Constructor1 Properties14 Methods35 Source

Constructor

new Client(options: ClientOptions)

Param	Type	Description
options	`ClientOptions`

Properties

cache: CacheController (readonly)

Cache limits, stats, sweeps, and cascade entry points.

channels: ChannelManager (readonly)

Channel cache and manager.

events: ClientEventMethods (readonly)

Typed event handlers. Prefer `client.events.*` or `client.on(Events.*, ...)`.

guilds: GuildManager (readonly)

Guild cache and manager.

instance: ResolvedInstance (readonly)

Resolved instance endpoints (API, CDN, invite, …) for this client. Isolated per client — safe for multi-instance processes.

logger: Logger (readonly)

Structured logger (zero-dep).

options: ClientOptions (readonly)

Resolved client options (cache defaults applied).

packs: PackManager (readonly)

Emoji/sticker pack REST wrappers (`/packs/*`).

readyAt: Date | null

Timestamp when the client became ready. Null until READY is received.

rest: REST (readonly)

REST client for making API requests.

Routes: any (readonly)

user: ClientUser | null

The authenticated bot user. Null until READY is received.

users: UserManager (readonly)

User cache and manager.

ws: WebSocketManager (readonly)

The underlying WebSocketManager (throws if not logged in).

Methods

assertReady(): void

Assertion that client is ready (throws if not).

bulkFetchMessages

(requests: BulkFetchMessagesRequest[], options?: BulkFetchMessagesOptions & { hydrate?: true }): Promise<BulkFetchMessagesResult>

Param	Type	Description
requests	`BulkFetchMessagesRequest[]`
options?	`BulkFetchMessagesOptions & { hydrate?: true }`

bulkFetchMessages

(requests: BulkFetchMessagesRequest[], options: BulkFetchMessagesOptions & { hydrate: false }): Promise<APIBulkMessageFetchResponse>

Param	Type	Description
requests	`BulkFetchMessagesRequest[]`
options	`BulkFetchMessagesOptions & { hydrate: false }`

bulkFetchMessages

(requests: BulkFetchMessagesRequest[], options: BulkFetchMessagesOptions): Promise<BulkFetchMessagesResult | APIBulkMessageFetchResponse>

Param	Type	Description
requests	`BulkFetchMessagesRequest[]`
options	`BulkFetchMessagesOptions`

checkUsernameTag(username: string, discriminator: string): Promise<APIUserTagCheck>

Check username#discriminator availability.

Param	Type	Description
username	`string`	Username to check
discriminator	`string`	Discriminator to check

destroy(): Promise<void>

Disconnect from gateway, clear all caches, and reset state. Safe to call login again after destroy.

emit(event: , args: ClientEvents[]): boolean

Emit an event with typed arguments.

Param	Type	Description
event	`K`
args	`ClientEvents[]`

emit(event: string | symbol, args: unknown[]): boolean

Param	Type	Description
event	`string \| symbol`
args	`unknown[]`

emit(event: string | symbol, args: unknown[]): boolean

Param	Type	Description
event	`string \| symbol`
args	`unknown[]`

fetchApplication(): Promise<APIApplicationMe>

Fetch the current application (`/applications/@me`).

fetchEmojiMetadata(emojiId: string): Promise<APIEmojiMetadata>

Fetch emoji metadata by ID.

Param	Type	Description
emojiId	`string`	Emoji snowflake

fetchGatewayInfo(): Promise<APIGatewayBotResponse>

Fetch gateway connection info (`/gateway`).

fetchInstance(): Promise<APIInstance>

Fetch instance discovery document (`/.well-known/fluxer`).

fetchOAuthApplications(): Promise<APIOAuthApplication[]>

Fetch OAuth2 applications owned by this bot.

fetchStickerMetadata(stickerId: string): Promise<APIStickerMetadata>

Fetch sticker metadata by ID.

Param	Type	Description
stickerId	`string`	Sticker snowflake

fromDiscovery

(origin: DiscoveryOrigin, options: Omit<ClientOptions, 'instance'>, connectOptions?: { signal?: AbortSignal; }): Promise<Client>

Create a client from instance discovery (`GET /.well-known/fluxer`). Does not log in — call login with a token afterward.

Param	Type	Description
origin	`DiscoveryOrigin`	API origin used only to fetch discovery (e.g. `https://api.example.com`)
options	`Omit<ClientOptions, 'instance'>`	Client options (must not conflict with discovered `endpoints.api`)
connectOptions?	`{ signal?: AbortSignal; }`	Optional abort signal for the discovery request

getOrCreateUser(data: APIUserPartial): User

Get or create a User from partial API data (hydrates cache).

Param	Type	Description
data	`APIUserPartial`	Partial user data from API

isReady(): boolean

Type guard for ready state (narrows `client.user` to non-null).

Connect to the gateway with a bot token.

Param	Type	Description
token	`string`	Bot token from the developer portal
options?	`{ signal?: AbortSignal; }`	Optional abort signal for cancellation

off(event: , listener: ClientEventListener<>): this

Remove an event listener for a specific event type.

Param	Type	Description
event	`K`
listener	`ClientEventListener<>`

off(event: string | symbol, listener: (...args: unknown[]) => void): this

Param	Type	Description
event	`string \| symbol`
listener	`(...args: unknown[]) => void`

off(event: string | symbol, listener: (...args: unknown[]) => void): this

Param	Type	Description
event	`string \| symbol`
listener	`(...args: unknown[]) => void`

on(event: , listener: ClientEventListener<>): this

Param	Type	Description
event	`K`
listener	`ClientEventListener<>`

on(event: string | symbol, listener: (...args: unknown[]) => void): this

Param	Type	Description
event	`string \| symbol`
listener	`(...args: unknown[]) => void`

on(event: string | symbol, listener: (...args: unknown[]) => void): this

Param	Type	Description
event	`string \| symbol`
listener	`(...args: unknown[]) => void`

once(event: , listener: ClientEventListener<>): this

Param	Type	Description
event	`K`
listener	`ClientEventListener<>`

once(event: string | symbol, listener: (...args: unknown[]) => void): this

Param	Type	Description
event	`string \| symbol`
listener	`(...args: unknown[]) => void`

once(event: string | symbol, listener: (...args: unknown[]) => void): this

Param	Type	Description
event	`string \| symbol`
listener	`(...args: unknown[]) => void`

preloadMessages(channelIds: string[]): Promise<APIPreloadMessagesResponse>

Preload recent messages for multiple channels (batch endpoint).

Param	Type	Description
channelIds	`string[]`	Array of channel IDs to preload

preloadMessagesAlt(channelIds: string[]): Promise<APIPreloadMessagesResponse>

Preload recent messages (alternate endpoint).

Param	Type	Description
channelIds	`string[]`	Array of channel IDs to preload

requestGuildMembers

(options: { guildId?: string; guildIds?: string[]; query?: string; limit?: number; userIds?: string[]; presences?: boolean; nonce?: string; }): void

Request guild members via gateway opcode 8 (`GUILD_MEMBERS_CHUNK` responses). Provide `guildId` and/or `guildIds`.

Param	Type	Description
options	`{ guildId?: string; guildIds?: string[]; query?: string; limit?: number; userIds?: string[]; presences?: boolean; nonce?: string; }`

resolveEmoji(emoji: string | { name: string; id?: string; animated?: boolean }, guildId?: string | null): Promise<string>

Resolve emoji input to API format (e.g., `name:id` or Unicode).

Param	Type	Description
emoji	`string \| { name: string; id?: string; animated?: boolean }`	Emoji string or object with name/id/animated
guildId?	`string \| null`	Guild ID for custom emoji lookup (optional)

sendToGateway(shardId: number, payload: GatewaySendPayload): void

Send a gateway payload to a specific shard.

Param	Type	Description
shardId	`number`	Shard ID (0-indexed)
payload	`GatewaySendPayload`	Gateway send payload (opcode + data)

sweepMembers(filter?: (member: GuildMember, guildId: string) => boolean): number

Sweep cached members across all guilds (remove entries matching filter). Prefer CacheController (`client.cache.sweepMembers`).

Param	Type	Description
filter?	`(member: GuildMember, guildId: string) => boolean`	Predicate to test each member (return true to remove)

sweepMessages(filter?: (message: APIMessage, channelId: string) => boolean, channelId?: string): number

Sweep cached messages (remove entries matching filter). Prefer CacheController (`client.cache.sweepMessages`).

Param	Type	Description
filter?	`(message: APIMessage, channelId: string) => boolean`	Predicate to test each message (return true to remove)
channelId?	`string`	Optional channel ID to scope sweep