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

Document GuildChannel.edit, add VoiceChannel.setUserLimit, fix typo (#866)

Browse Source
This commit is contained in:
Programmix
2016-10-31 22:42:05 -07:00
committed by Schuyler Cebulskie
parent 2a50dad852
commit 9a61de1493
5 changed files with 57 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/structures/GuildChannel.js
View File

@@ -161,6 +161,26 @@ class GuildChannel extends Channel {
return this.client.rest.methods.setChannelOverwrite(this, payload);
}
/**
* The data for a guild channel
* @typedef {Object} ChannelData
* @property {string} [name] The name of the channel
* @property {number} [position] The position of the channel
* @property {string} [topic] The topic of the text channel
* @property {number} [bitrate] The bitrate of the voice channel
* @property {number} [userLimit] The user limit of the channel
*/
/**
* Edits the channel
* @param {ChannelData} data The new data for the channel
* @returns {Promise<GuildChannel>}
* @example
* // edit a channel
* channel.edit({name: 'new-channel'})
* .then(c => console.log(`Edited channel ${c}`))
* .catch(console.error);
*/
edit(data) {
return this.client.rest.methods.updateChannel(this, data);
}
@@ -176,7 +196,7 @@ class GuildChannel extends Channel {
* .catch(console.error);
*/
setName(name) {
return this.client.rest.methods.updateChannel(this, { name });
return this.edit({ name });
}
/**