discord.js | Client

Search...

Client

export declare class Client extends AsyncEventEmitter<MappedEvents>

export declare class Client extends AsyncEventEmitter<MappedEvents>

No summary provided.

Extends

AsyncEventEmitter<MappedEvents>

constructor({ rest, gateway })

Constructs a new instance of the Client class

Name	Type	Optional	Description
{ rest, gateway }	ClientOptions	No	None

Readonly

api:API

Readonly

gateway:Gateway

Readonly

rest:REST

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

Requests guild members from the gateway.

Example

Requesting specific members from a guild

const { members } = await client.requestGuildMembers({ guild_id: '1234567890', user_ids: ['9876543210'] });

const { members } = await client.requestGuildMembers({ guild_id: '1234567890', user_ids: ['9876543210'] });

Name	Type	Optional	Description
options	GatewayRequestGuildMembersData	No	The options for the request
timeout	number	Yes	The timeout for waiting for each guild members chunk event

Example

Requesting all members from a guild

for await (const { members } of client.requestGuildMembersIterator({ guild_id: '1234567890', query: '', limit: 0 })) {
	console.log(members);
}

for await (const { members } of client.requestGuildMembersIterator({ guild_id: '1234567890', query: '', limit: 0 })) {
	console.log(members);
}

Name	Type	Optional	Description
options	GatewayRequestGuildMembersData	No	The options for the request
timeout	number	Yes	The timeout for waiting for each guild members chunk event

Example

Requesting soundboard sounds for specific guilds

const soundboardSounds = await client.requestSoundboardSounds({ guild_ids: ['1234567890', '9876543210'], });

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

const soundboardSounds = await client.requestSoundboardSounds({ guild_ids: ['1234567890', '9876543210'], });

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

Name	Type	Optional	Description
options	GatewayRequestSoundboardSoundsData	No	The options for the request
timeout	number	Yes	The timeout for waiting for each soundboard sounds event

Example

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);
}

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

Client

Extends

Example

See Also

Example

See Also

Example

See Also

Example

See Also

See Also

Name	Type	Optional	Description
shardId	number	No	The id of the shard to update the presence in
options	GatewayPresenceUpdateData	No	The options for updating the presence