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

refactor(guildbanmanager)!: rename days option to deleteMessageDays (#7447)

Browse Source
This commit is contained in:
Rodry
2022-02-13 15:51:56 +00:00
committed by GitHub
parent ae0f35f51d
commit 0dfdb2cf11
4 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/discord.js/src/managers/GuildBanManager.js
View File

@@ -120,7 +120,7 @@ class GuildBanManager extends CachedManager {
/** /**
* Options used to ban a user from a guild. * Options used to ban a user from a guild.
* @typedef {Object} BanOptions * @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 * @property {string} [reason] The reason for the ban
*/ */
@@ -142,7 +142,7 @@ class GuildBanManager extends CachedManager {
const id = this.client.users.resolveId(user); const id = this.client.users.resolveId(user);
if (!id) throw new Error('BAN_RESOLVE_ID', true); if (!id) throw new Error('BAN_RESOLVE_ID', true);
await this.client.rest.put(Routes.guildBan(this.guild.id, id), { 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, reason: options.reason,
}); });
if (user instanceof GuildMember) return user; if (user instanceof GuildMember) return user;

2
packages/discord.js/src/managers/GuildMemberManager.js
View File

@@ -389,7 +389,7 @@ class GuildMemberManager extends CachedManager {
* .then(banInfo => console.log(`Banned ${banInfo.user?.tag ?? banInfo.tag ?? banInfo}`)) * .then(banInfo => console.log(`Banned ${banInfo.user?.tag ?? banInfo.tag ?? banInfo}`))
* .catch(console.error); * .catch(console.error);
*/ */
ban(user, options = { days: 0 }) { ban(user, options) {
return this.guild.bans.create(user, options); return this.guild.bans.create(user, options);
} }

2
packages/discord.js/src/structures/GuildMember.js
View File

@@ -348,7 +348,7 @@ class GuildMember extends Base {
* @returns {Promise<GuildMember>} * @returns {Promise<GuildMember>}
* @example * @example
* // ban a guild member * // ban a guild member
* guildMember.ban({ days: 7, reason: 'They deserved it' }) * guildMember.ban({ deleteMessageDays: 7, reason: 'They deserved it' })
* .then(console.log) * .then(console.log)
* .catch(console.error); * .catch(console.error);
*/ */

2
packages/discord.js/typings/index.d.ts vendored
View File

@@ -3402,7 +3402,7 @@ export interface AwaitReactionsOptions extends ReactionCollectorOptions {
} }
export interface BanOptions { export interface BanOptions {
days?: number; deleteMessageDays?: number;
reason?: string; reason?: string;
} }