Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-19 21:13:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Correctly overwrite setRTCRegion method (#8642)

Browse Source 
docs: correctly overwrite `setRTCRegion` method

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
Jiralite
2022-09-19 22:07:58 +01:00
committed by GitHub
parent f6f15d8e87
commit f0497343f1
2 changed files with 32 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
packages/discord.js/src/structures/StageChannel.js
View File

@@ -51,20 +51,22 @@ class StageChannel extends BaseGuildVoiceChannel {
setTopic(topic, reason) { setTopic(topic, reason) {
return this.edit({ topic, reason }); return this.edit({ topic, reason });
} }
/**
* Sets the RTC region of the channel.
* @name StageChannel#setRTCRegion
* @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
* @param {string} [reason] The reason for modifying this region.
* @returns {Promise<StageChannel>}
* @example
* // Set the RTC region to sydney
* stageChannel.setRTCRegion('sydney');
* @example
* // Remove a fixed region for this channel - let Discord decide automatically
* stageChannel.setRTCRegion(null, 'We want to let Discord decide.');
*/
} }
/**
* Sets the RTC region of the channel.
* @method setRTCRegion
* @memberof StageChannel
* @instance
* @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
* @param {string} [reason] The reason for modifying this region.
* @returns {Promise<StageChannel>}
* @example
* // Set the RTC region to sydney
* stageChannel.setRTCRegion('sydney');
* @example
* // Remove a fixed region for this channel - let Discord decide automatically
* stageChannel.setRTCRegion(null, 'We want to let Discord decide.');
*/
module.exports = StageChannel; module.exports = StageChannel;

30
packages/discord.js/src/structures/VoiceChannel.js
View File

@@ -149,22 +149,24 @@ class VoiceChannel extends BaseGuildVoiceChannel {
createWebhook() {} createWebhook() {}
setRateLimitPerUser() {} setRateLimitPerUser() {}
setNSFW() {} setNSFW() {}
/**
* Sets the RTC region of the channel.
* @name VoiceChannel#setRTCRegion
* @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
* @param {string} [reason] The reason for modifying this region.
* @returns {Promise<VoiceChannel>}
* @example
* // Set the RTC region to sydney
* voiceChannel.setRTCRegion('sydney');
* @example
* // Remove a fixed region for this channel - let Discord decide automatically
* voiceChannel.setRTCRegion(null, 'We want to let Discord decide.');
*/
} }
TextBasedChannel.applyToClass(VoiceChannel, true, ['lastPinAt']); TextBasedChannel.applyToClass(VoiceChannel, true, ['lastPinAt']);
/**
* Sets the RTC region of the channel.
* @method setRTCRegion
* @memberof VoiceChannel
* @instance
* @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
* @param {string} [reason] The reason for modifying this region.
* @returns {Promise<VoiceChannel>}
* @example
* // Set the RTC region to sydney
* voiceChannel.setRTCRegion('sydney');
* @example
* // Remove a fixed region for this channel - let Discord decide automatically
* voiceChannel.setRTCRegion(null, 'We want to let Discord decide.');
*/
module.exports = VoiceChannel; module.exports = VoiceChannel;