docs: Correctly overwrite setRTCRegion method (#8642)

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

View File

@@ -51,10 +51,13 @@ 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. * Sets the RTC region of the channel.
* @name StageChannel#setRTCRegion * @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} 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. * @param {string} [reason] The reason for modifying this region.
* @returns {Promise<StageChannel>} * @returns {Promise<StageChannel>}
@@ -65,6 +68,5 @@ class StageChannel extends BaseGuildVoiceChannel {
* // Remove a fixed region for this channel - let Discord decide automatically * // Remove a fixed region for this channel - let Discord decide automatically
* stageChannel.setRTCRegion(null, 'We want to let Discord decide.'); * stageChannel.setRTCRegion(null, 'We want to let Discord decide.');
*/ */
}
module.exports = StageChannel; module.exports = StageChannel;

View File

@@ -149,10 +149,15 @@ class VoiceChannel extends BaseGuildVoiceChannel {
createWebhook() {} createWebhook() {}
setRateLimitPerUser() {} setRateLimitPerUser() {}
setNSFW() {} setNSFW() {}
}
TextBasedChannel.applyToClass(VoiceChannel, true, ['lastPinAt']);
/** /**
* Sets the RTC region of the channel. * Sets the RTC region of the channel.
* @name VoiceChannel#setRTCRegion * @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} 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. * @param {string} [reason] The reason for modifying this region.
* @returns {Promise<VoiceChannel>} * @returns {Promise<VoiceChannel>}
@@ -163,8 +168,5 @@ class VoiceChannel extends BaseGuildVoiceChannel {
* // Remove a fixed region for this channel - let Discord decide automatically * // Remove a fixed region for this channel - let Discord decide automatically
* voiceChannel.setRTCRegion(null, 'We want to let Discord decide.'); * voiceChannel.setRTCRegion(null, 'We want to let Discord decide.');
*/ */
}
TextBasedChannel.applyToClass(VoiceChannel, true, ['lastPinAt']);
module.exports = VoiceChannel; module.exports = VoiceChannel;