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

feat(GuildBanManager#create): add deleteMessageSeconds (#8326)

Browse Source 
* feat(GuildBanManager#create): add `deleteMessageSeconds`

* Apply suggestions from code review

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>

* chore: remove typeof and return undefined if neither are set

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
advaith
2022-09-08 06:15:01 -07:00
committed by GitHub
parent ce991dd1d8
commit 03fb5b0a2f
3 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -129,6 +129,9 @@ 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} [deleteMessageDays] 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
* <warn>This property is deprecated. Use `deleteMessageSeconds` instead.</warn>
* @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 * @property {string} [reason] The reason for the ban
*/ */
@@ -150,7 +153,11 @@ class GuildBanManager extends CachedManager {
const id = this.client.users.resolveId(user); const id = this.client.users.resolveId(user);
if (!id) throw new Error(ErrorCodes.BanResolveId, true); if (!id) throw new Error(ErrorCodes.BanResolveId, 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.deleteMessageDays }, body: {
delete_message_seconds:
options.deleteMessageSeconds ??
(options.deleteMessageDays ? options.deleteMessageDays * 24 * 60 * 60 : undefined),
},
reason: options.reason, reason: options.reason,
}); });
if (user instanceof GuildMember) return user; if (user instanceof GuildMember) return user;

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

@@ -355,8 +355,8 @@ class GuildMember extends Base {
* @param {BanOptions} [options] Options for the ban * @param {BanOptions} [options] Options for the ban
* @returns {Promise<GuildMember>} * @returns {Promise<GuildMember>}
* @example * @example
* // ban a guild member * // Ban a guild member, deleting a week's worth of messages
* guildMember.ban({ deleteMessageDays: 7, reason: 'They deserved it' }) * guildMember.ban({ deleteMessageSeconds: 60 * 60 * 24 * 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

@@ -4057,7 +4057,9 @@ export interface AwaitReactionsOptions extends ReactionCollectorOptions {
} }
export interface BanOptions { export interface BanOptions {
/** @deprecated Use {@link deleteMessageSeconds} instead. */
deleteMessageDays?: number; deleteMessageDays?: number;
deleteMessageSeconds?: number;
reason?: string; reason?: string;
} }