class Client

export declare class Client extends AsyncEventEmitter<MappedEvents>
api
gateway
rest
requestGuildMembers
requestGuildMembersIterator
requestSoundboardSounds
requestSoundboardSoundsIterator
updatePresence
updateVoiceState

Constructors

constructor(
options: ClientOptions
)

Constructs a new instance of the Client class

readonly
api : API

readonly
gateway : Gateway

readonly
rest : REST

requestGuildMembers(
options: GatewayRequestGuildMembersData
timeout?: number
) : Promise<{ members: APIGuildMember[]; nonce: string; notFound: unknown[]; presences: GatewayGuildMembersChunkPresence[]; }>

Requests guild members from the gateway.

Examples:Requesting specific members from a guild
const { members } = await client.requestGuildMembers({ guild_id: '1234567890', user_ids: ['9876543210'] });

See also: https://discord.com/developers/docs/topics/gateway-events#request-guild-members

requestGuildMembersIterator(
options: GatewayRequestGuildMembersData
timeout?: number
) : AsyncGenerator<{ members: APIGuildMember[]; nonce: string; notFound: unknown[] | null; presences: GatewayGuildMembersChunkPresence[] | null; chunkIndex: number; chunkCount: number; }, void, unknown>

Requests guild members from the gateway and returns an async iterator that yields the data from each guild members chunk event.

Examples:Requesting all members from a guild
for await (const { members } of client.requestGuildMembersIterator({ guild_id: '1234567890', query: '', limit: 0 })) {
	console.log(members);
}

See also: https://discord.com/developers/docs/topics/gateway-events#request-guild-members

requestSoundboardSounds(
options: GatewayRequestSoundboardSoundsData
timeout?: number
) : Promise<Map<string, APISoundboardSound[]>>

Requests soundboard sounds from the gateway.

Examples:Requesting soundboard sounds for specific guilds
const soundboardSounds = await client.requestSoundboardSounds({ guild_ids: ['1234567890', '9876543210'], });

console.log(soundboardSounds.get('1234567890'));

See also: https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds

requestSoundboardSoundsIterator(
options: GatewayRequestSoundboardSoundsData
timeout?: number
) : AsyncGenerator<{ guildId: string; soundboardSounds: APISoundboardSound[]; }, void, unknown>

Requests soundboard sounds from the gateway and returns an async iterator that yields the data from each soundboard sounds event.

Examples:Requesting soundboard sounds for specific guilds
for await (const { guildId, soundboardSounds } of this.requestSoundboardSoundsIterator({
	guild_ids: ['1234567890', '9876543210'],
})) {
	console.log(`Soundboard sounds for guild ${guildId}:`, soundboardSounds);
}

See also: https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds

updatePresence(
shardId: number
options: GatewayPresenceUpdateData
) : Promise<void>

Updates the presence of the bot user

updateVoiceState(
options: GatewayVoiceStateUpdateData
) : Promise<void>

Updates the voice state of the bot user

See also: https://discord.com/developers/docs/topics/gateway-events#update-voice-state