From 0dfdb2cf11e236e67dd34277108973b5b79790a8 Mon Sep 17 00:00:00 2001 From: Rodry <38259440+ImRodry@users.noreply.github.com> Date: Sun, 13 Feb 2022 15:51:56 +0000 Subject: [PATCH] refactor(guildbanmanager)!: rename days option to deleteMessageDays (#7447) --- packages/discord.js/src/managers/GuildBanManager.js | 4 ++-- packages/discord.js/src/managers/GuildMemberManager.js | 2 +- packages/discord.js/src/structures/GuildMember.js | 2 +- packages/discord.js/typings/index.d.ts | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/discord.js/src/managers/GuildBanManager.js b/packages/discord.js/src/managers/GuildBanManager.js index df262417f..d459cfbee 100644 --- a/packages/discord.js/src/managers/GuildBanManager.js +++ b/packages/discord.js/src/managers/GuildBanManager.js @@ -120,7 +120,7 @@ class GuildBanManager extends CachedManager { /** * Options used to ban a user from a guild. * @typedef {Object} BanOptions - * @property {number} [days] Number of days of messages to delete, must be between 0 and 7, inclusive + * @property {number} [deleteMessageDays] Number of days of messages to delete, must be between 0 and 7, inclusive * @property {string} [reason] The reason for the ban */ @@ -142,7 +142,7 @@ class GuildBanManager extends CachedManager { const id = this.client.users.resolveId(user); if (!id) throw new Error('BAN_RESOLVE_ID', true); await this.client.rest.put(Routes.guildBan(this.guild.id, id), { - body: { delete_message_days: options.days }, + body: { delete_message_days: options.deleteMessageDays }, reason: options.reason, }); if (user instanceof GuildMember) return user; diff --git a/packages/discord.js/src/managers/GuildMemberManager.js b/packages/discord.js/src/managers/GuildMemberManager.js index e5b436a05..086d43c5c 100644 --- a/packages/discord.js/src/managers/GuildMemberManager.js +++ b/packages/discord.js/src/managers/GuildMemberManager.js @@ -389,7 +389,7 @@ class GuildMemberManager extends CachedManager { * .then(banInfo => console.log(`Banned ${banInfo.user?.tag ?? banInfo.tag ?? banInfo}`)) * .catch(console.error); */ - ban(user, options = { days: 0 }) { + ban(user, options) { return this.guild.bans.create(user, options); } diff --git a/packages/discord.js/src/structures/GuildMember.js b/packages/discord.js/src/structures/GuildMember.js index c04649a37..a02fd7acf 100644 --- a/packages/discord.js/src/structures/GuildMember.js +++ b/packages/discord.js/src/structures/GuildMember.js @@ -348,7 +348,7 @@ class GuildMember extends Base { * @returns {Promise} * @example * // ban a guild member - * guildMember.ban({ days: 7, reason: 'They deserved it' }) + * guildMember.ban({ deleteMessageDays: 7, reason: 'They deserved it' }) * .then(console.log) * .catch(console.error); */ diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts index fd2dc0533..3aaf7949e 100644 --- a/packages/discord.js/typings/index.d.ts +++ b/packages/discord.js/typings/index.d.ts @@ -3402,7 +3402,7 @@ export interface AwaitReactionsOptions extends ReactionCollectorOptions { } export interface BanOptions { - days?: number; + deleteMessageDays?: number; reason?: string; }