diff --git a/src/managers/GuildBanManager.js b/src/managers/GuildBanManager.js
index e67fd4357c31..543ed1dbcec1 100644
--- a/src/managers/GuildBanManager.js
+++ b/src/managers/GuildBanManager.js
@@ -1,11 +1,14 @@
'use strict';
+const process = require('node:process');
const { Collection } = require('@discordjs/collection');
const CachedManager = require('./CachedManager');
const { TypeError, Error } = require('../errors');
const GuildBan = require('../structures/GuildBan');
const { GuildMember } = require('../structures/GuildMember');
+let deprecationEmittedForDays = false;
+
/**
* Manages API methods for GuildBans and stores their cache.
* @extends {CachedManager}
@@ -126,6 +129,9 @@ class GuildBanManager extends CachedManager {
* Options used to ban a user from a guild.
* @typedef {Object} BanOptions
* @property {number} [days=0] Number of days of messages to delete, must be between 0 and 7, inclusive
+ * This property is deprecated. Use `deleteMessageSeconds` instead.
+ * @property {number} [deleteMessageSeconds] Number of seconds of messages to delete,
+ * must be between 0 and 604800 (7 days), inclusive
* @property {string} [reason] The reason for the ban
*/
@@ -142,15 +148,30 @@ class GuildBanManager extends CachedManager {
* .then(banInfo => console.log(`Banned ${banInfo.user?.tag ?? banInfo.tag ?? banInfo}`))
* .catch(console.error);
*/
- async create(user, options = { days: 0 }) {
+ async create(user, options = {}) {
if (typeof options !== 'object') throw new TypeError('INVALID_TYPE', 'options', 'object', true);
const id = this.client.users.resolveId(user);
if (!id) throw new Error('BAN_RESOLVE_ID', true);
+
+ if (typeof options.days !== 'undefined' && !deprecationEmittedForDays) {
+ process.emitWarning(
+ 'The days option for GuildBanManager#create() is deprecated. Use the deleteMessageSeconds option instead.',
+ 'DeprecationWarning',
+ );
+
+ deprecationEmittedForDays = true;
+ }
+
await this.client.api
.guilds(this.guild.id)
.bans(id)
.put({
- data: { delete_message_days: options.days },
+ data: {
+ delete_message_seconds:
+ typeof options.deleteMessageSeconds !== 'undefined'
+ ? options.deleteMessageSeconds
+ : (options.days ?? 0) * 24 * 60 * 60,
+ },
reason: options.reason,
});
if (user instanceof GuildMember) return user;
diff --git a/src/managers/GuildMemberManager.js b/src/managers/GuildMemberManager.js
index 7dd7a6045d49..4a20d38f355a 100644
--- a/src/managers/GuildMemberManager.js
+++ b/src/managers/GuildMemberManager.js
@@ -379,7 +379,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/src/structures/GuildMember.js b/src/structures/GuildMember.js
index 16da298b14a3..0a2c82c276b5 100644
--- a/src/structures/GuildMember.js
+++ b/src/structures/GuildMember.js
@@ -378,8 +378,8 @@ class GuildMember extends Base {
* @param {BanOptions} [options] Options for the ban
* @returns {Promise}
* @example
- * // ban a guild member
- * guildMember.ban({ days: 7, reason: 'They deserved it' })
+ * // Ban a guild member, deleting a week's worth of messages
+ * guildMember.ban({ deleteMessageSeconds: 60 * 60 * 24 * 7, reason: 'They deserved it' })
* .then(console.log)
* .catch(console.error);
*/
diff --git a/typings/index.d.ts b/typings/index.d.ts
index 71eae07806ec..9fd52efaf61f 100644
--- a/typings/index.d.ts
+++ b/typings/index.d.ts
@@ -4034,7 +4034,9 @@ export interface AwaitReactionsOptions extends ReactionCollectorOptions {
}
export interface BanOptions {
+ /** @deprecated Use {@link deleteMessageSeconds} instead. */
days?: number;
+ deleteMessageSeconds?: number;
reason?: string;
}