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

fix(Message): update typings and docs related to #edit (#5745)

Browse Source 
Co-authored-by: Jan <66554238+vaporox@users.noreply.github.com>
This commit is contained in:
Shubham Parihar
2021-06-03 23:48:13 +05:30
committed by GitHub
parent ff4d6dded5
commit a2f0c11474
2 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/structures/Message.js
View File

@@ -474,7 +474,7 @@ class Message extends Base {
/** /**
* Options that can be passed into {@link Message#edit}. * Options that can be passed into {@link Message#edit}.
* @typedef {Object} MessageEditOptions * @typedef {Object} MessageEditOptions
* @property {string} [content] Content to be edited * @property {?string} [content] Content to be edited
* @property {MessageEmbed|Object} [embed] An embed to be added/edited * @property {MessageEmbed|Object} [embed] An embed to be added/edited
* @property {string|boolean} [code] Language for optional codeblock formatting to apply * @property {string|boolean} [code] Language for optional codeblock formatting to apply
* @property {MessageMentionOptions} [allowedMentions] Which mentions should be parsed from the message content * @property {MessageMentionOptions} [allowedMentions] Which mentions should be parsed from the message content
@@ -486,8 +486,8 @@ class Message extends Base {
/** /**
* Edits the content of the message. * Edits the content of the message.
* @param {string|APIMessage} [content] The new content for the message * @param {?string|APIMessage} [content] The new content for the message
* @param {MessageEditOptions|MessageEmbed} [options] The options to provide * @param {MessageEditOptions|MessageEmbed|MessageAttachment|MessageAttachment[]} [options] The options to provide
* @returns {Promise<Message>} * @returns {Promise<Message>}
* @example * @example
* // Update the content of a message * // Update the content of a message

11
typings/index.d.ts vendored
View File

@@ -1186,8 +1186,13 @@ declare module 'discord.js' {
options?: ReactionCollectorOptions, options?: ReactionCollectorOptions,
): ReactionCollector; ): ReactionCollector;
public delete(): Promise<Message>; public delete(): Promise<Message>;
public edit(content: string | null | MessageEditOptions | MessageEmbed | APIMessage): Promise<Message>; public edit(
public edit(content: string | null, options: MessageEditOptions | MessageEmbed): Promise<Message>; content: string | null | MessageEditOptions | MessageEmbed | APIMessage | MessageAttachment | MessageAttachment[],
): Promise<Message>;
public edit(
content: string | null,
options: MessageEditOptions | MessageEmbed | MessageAttachment | MessageAttachment[],
): Promise<Message>;
public equals(message: Message, rawData: unknown): boolean; public equals(message: Message, rawData: unknown): boolean;
public fetchReference(): Promise<Message>; public fetchReference(): Promise<Message>;
public fetchWebhook(): Promise<Webhook>; public fetchWebhook(): Promise<Webhook>;
@@ -3208,7 +3213,7 @@ declare module 'discord.js' {
interface MessageEditOptions { interface MessageEditOptions {
attachments?: MessageAttachment[]; attachments?: MessageAttachment[];
content?: string; content?: string | null;
embed?: MessageEmbed | MessageEmbedOptions | null; embed?: MessageEmbed | MessageEmbedOptions | null;
code?: string | boolean; code?: string | boolean;
files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[]; files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[];