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

Doc fixes (#1197)

Browse Source 
* Improve ban/unban examples

* Fix example comments

* Replace nondescript 'user' parameter with 'some user ID'

* Update Guild.js

* Update Guild.js
This commit is contained in:
Jamelele
2017-02-19 21:06:18 +00:00
committed by Schuyler Cebulskie
parent 12136f8c54
commit 1273bb42ec
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/structures/Guild.js
View File

@@ -572,8 +572,10 @@ class Guild {
* If the GuildMember cannot be resolved, the User will instead be attempted to be resolved. If that also cannot * If the GuildMember cannot be resolved, the User will instead be attempted to be resolved. If that also cannot
* be resolved, the user ID will be the result. * be resolved, the user ID will be the result.
* @example * @example
* // ban a user * // ban a user by ID (or with a user/guild member object)
* guild.ban('123123123123'); * guild.ban('some user ID')
* .then(user => console.log(`Banned ${user.username || user.id || user} from ${guild.name}`))
* .catch(console.error);
*/ */
ban(user, deleteDays = 0) { ban(user, deleteDays = 0) {
return this.client.rest.methods.banGuildMember(this, user, deleteDays); return this.client.rest.methods.banGuildMember(this, user, deleteDays);
@@ -584,10 +586,10 @@ class Guild {
* @param {UserResolvable} user The user to unban * @param {UserResolvable} user The user to unban
* @returns {Promise<User>} * @returns {Promise<User>}
* @example * @example
* // unban a user * // unban a user by ID (or with a user/guild member object)
* guild.unban('123123123123') * guild.unban('some user ID')
* .then(user => console.log(`Unbanned ${user.username} from ${guild.name}`)) * .then(user => console.log(`Unbanned ${user.username} from ${guild.name}`))
* .catch(reject); * .catch(console.error);
*/ */
unban(user) { unban(user) {
return this.client.rest.methods.unbanGuildMember(this, user); return this.client.rest.methods.unbanGuildMember(this, user);