refactor(Message): remove options for Message#delete (#4999)

This commit is contained in:
Jan
2020-12-14 13:52:04 +01:00
committed by GitHub
parent 41078997ae
commit 75e6dfbfd3
3 changed files with 9 additions and 22 deletions

View File

@@ -116,14 +116,13 @@ class MessageManager extends BaseManager {
/**
* Deletes a message, even if it's not cached.
* @param {MessageResolvable} message The message to delete
* @param {string} [reason] Reason for deleting this message, if it does not belong to the client user
* @returns {Promise<void>}
*/
async delete(message, reason) {
async delete(message) {
message = this.resolveID(message);
if (!message) throw new TypeError('INVALID_TYPE', 'message', 'MessageResolvable');
await this.client.api.channels(this.channel.id).messages(message).delete({ reason });
await this.client.api.channels(this.channel.id).messages(message).delete();
}
async _fetchId(messageID, cache, force) {

View File

@@ -579,28 +579,16 @@ class Message extends Base {
/**
* Deletes the message.
* @param {Object} [options] Options
* @param {number} [options.timeout=0] How long to wait to delete the message in milliseconds
* @param {string} [options.reason] Reason for deleting this message, if it does not belong to the client user
* @returns {Promise<Message>}
* @example
* // Delete a message
* message.delete({ timeout: 5000 })
* .then(msg => console.log(`Deleted message from ${msg.author.username} after 5 seconds`))
* message.delete()
* .then(msg => console.log(`Deleted message from ${msg.author.username}`))
* .catch(console.error);
*/
delete(options = {}) {
if (typeof options !== 'object') return Promise.reject(new TypeError('INVALID_TYPE', 'options', 'object', true));
const { timeout = 0, reason } = options;
if (timeout <= 0) {
return this.channel.messages.delete(this.id, reason).then(() => this);
} else {
return new Promise(resolve => {
this.client.setTimeout(() => {
resolve(this.delete({ reason }));
}, timeout);
});
}
async delete() {
await this.channel.messages.delete(this.id);
return this;
}
/**

4
typings/index.d.ts vendored
View File

@@ -993,7 +993,7 @@ declare module 'discord.js' {
options?: AwaitReactionsOptions,
): Promise<Collection<Snowflake, MessageReaction>>;
public createReactionCollector(filter: CollectorFilter, options?: ReactionCollectorOptions): ReactionCollector;
public delete(options?: { timeout?: number; reason?: string }): Promise<Message>;
public delete(): Promise<Message>;
public edit(
content: APIMessageContentResolvable | MessageEditOptions | MessageEmbed | APIMessage,
): Promise<Message>;
@@ -1978,7 +1978,7 @@ declare module 'discord.js' {
force?: boolean,
): Promise<Collection<Snowflake, Message>>;
public fetchPinned(cache?: boolean): Promise<Collection<Snowflake, Message>>;
public delete(message: MessageResolvable, reason?: string): Promise<void>;
public delete(message: MessageResolvable): Promise<void>;
}
// Hacky workaround because changing the signature of an overridden method errors