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

added a new Typedef for Bans you can get from <Guild>.fetchBans() and fixed a little typo in the fetchAuditLogs() method (#2108)

Browse Source 
* added a new Typedef for Bans you can get from <Guild>.fetchBans() due recent change aswell as fixed a little typo in the fetchAuditLogs() mehtod so .type has no the correct type defined

* little change due request

* fixed indentation

* Update Guild.js

* Update Guild.js
This commit is contained in:
Yukine
2017-11-30 05:36:03 +01:00
committed by Schuyler Cebulskie
parent 77fc046550
commit 134ef7a61b
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/structures/Guild.js
View File

@@ -441,10 +441,16 @@ class Guild extends Base {
return this.members.resolve(user); return this.members.resolve(user);
} }
/**
* An object containing information about a guild member's ban.
* @typedef {Object} BanInfo
* @property {User} user User that was banned
* @property {?string} reason Reason the user was banned
*/
/** /**
* Fetches a collection of banned users in this guild. * Fetches a collection of banned users in this guild.
* The returned collection contains user objects keyed under `user` and reasons keyed under `reason`. * @returns {Promise<Collection<Snowflake, BanInfo>>}
* @returns {Promise<Collection<Snowflake, Object>>}
*/ */
fetchBans() { fetchBans() {
return this.client.api.guilds(this.id).bans.get().then(bans => return this.client.api.guilds(this.id).bans.get().then(bans =>
@@ -506,7 +512,7 @@ class Guild extends Base {
* @param {Snowflake|GuildAuditLogsEntry} [options.after] Limit to entries from after specified entry * @param {Snowflake|GuildAuditLogsEntry} [options.after] Limit to entries from after specified entry
* @param {number} [options.limit] Limit number of entries * @param {number} [options.limit] Limit number of entries
* @param {UserResolvable} [options.user] Only show entries involving this user * @param {UserResolvable} [options.user] Only show entries involving this user
* @param {ActionType|number} [options.type] Only show entries involving this action type * @param {AuditLogAction|number} [options.type] Only show entries involving this action type
* @returns {Promise<GuildAuditLogs>} * @returns {Promise<GuildAuditLogs>}
*/ */
fetchAuditLogs(options = {}) { fetchAuditLogs(options = {}) {