Client

.assertReady()

→ void

Assertion that client is ready (throws if not).

client.assertReady();

.bulkFetchMessages(requests, options?)

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

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

client.bulkFetchMessages(requests);

.checkUsernameTag(username, discriminator)

username: string, discriminator: string → Promise<APIUserTagCheck>

Check username#discriminator availability.

username

stringUsername to check

discriminator

stringDiscriminator to check

client.checkUsernameTag(username, discriminator);

.destroy()

→ Promise<void>

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

await client.destroy();

.emit(event, args)

event: K, args: ClientEvents[K] → boolean

event: string | symbol, args: unknown[] → boolean

Emit an event with typed arguments.

client.emit(event, args);

.fetchApplication()

→ Promise<APIApplicationMe>

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

client.fetchApplication();

.fetchEmojiMetadata(emojiId)

emojiId: string → Promise<APIEmojiMetadata>

Fetch emoji metadata by ID.

emojiId

stringEmoji snowflake

client.fetchEmojiMetadata(emojiId);

.fetchGatewayInfo()

→ Promise<APIGatewayBotResponse>

Fetch gateway connection info (/gateway).

client.fetchGatewayInfo();

.fetchInstance()

→ Promise<APIInstance>

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

client.fetchInstance();

.fetchOAuthApplications()

→ Promise<APIOAuthApplication[]>

Fetch OAuth2 applications owned by this bot.

client.fetchOAuthApplications();

.fetchStickerMetadata(stickerId)

stickerId: string → Promise<APIStickerMetadata>

Fetch sticker metadata by ID.

stickerId

stringSticker snowflake

client.fetchStickerMetadata(stickerId);

static fromDiscovery(origin, options, connectOptions?)

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.

origin

DiscoveryOriginAPI 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

await Client.fromDiscovery(origin, options);

.isReady()

→ boolean

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

client.isReady();

.login(token, options?)

token: string, options?: { signal?: AbortSignal; } → Promise<string>

Connect to the gateway with a bot token.

token

stringBot token from the developer portal

options?

{ signal?: AbortSignal; }Optional abort signal for cancellation

await client.login(token);

.off(event, listener)

event: K, listener: ClientEventListener<K> → this

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

Remove an event listener for a specific event type.

client.off(event, listener);

.on(event, listener)

event: K, listener: ClientEventListener<K> → this

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

Register an event listener for a specific event type.

client.on(event, listener);

.once(event, listener)

event: K, listener: ClientEventListener<K> → this

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

Register a one-time event listener for a specific event type.

client.once(event, listener);

.preloadMessages(channelIds)

channelIds: string[] → Promise<APIPreloadMessagesResponse>

Preload recent messages for multiple channels (batch endpoint).

channelIds

string[]Array of channel IDs to preload

client.preloadMessages(channelIds);

.preloadMessagesAlt(channelIds)

channelIds: string[] → Promise<APIPreloadMessagesResponse>

Preload recent messages (alternate endpoint).

channelIds

string[]Array of channel IDs to preload

client.preloadMessagesAlt(channelIds);

.requestGuildMembers(options)

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.

client.requestGuildMembers(options);

.resolveEmoji(emoji, guildId?)

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).

emoji

string | { name: string; id?: string; animated?: boolean }Emoji string or object with name/id/animated

guildId?

string | nullGuild ID for custom emoji lookup (optional)

await client.resolveEmoji(emoji);

.sendToGateway(shardId, payload)

shardId: number, payload: GatewaySendPayload → void

Send a gateway payload to a specific shard.

shardId

numberShard ID (0-indexed)

payload

GatewaySendPayloadGateway send payload (opcode + data)

client.sendToGateway(shardId, payload);

.sweepMembers(filter?)

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

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

filter?

(member: GuildMember, guildId: string) => booleanPredicate to test each member (return true to remove)

client.sweepMembers();

.sweepMessages(filter?, channelId?)

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

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

filter?

(message: APIMessage, channelId: string) => booleanPredicate to test each message (return true to remove)

channelId?

stringOptional channel ID to scope sweep

client.sweepMessages();