Skip to content

Commit

Permalink
fix(Typings): fix typings and JSDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
castdrian committed Jun 6, 2021
1 parent 3db8625 commit e7bc965
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 25 deletions.
4 changes: 2 additions & 2 deletions src/structures/Message.js
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@ class Message extends Base {

/**
* Edits the content of the message.
* @param {MessageEditOptions|MessageEmbed|MessageAttachment|MessageAttachment[]} options The options to provide
* @param {MessageEditOptions} options The options to provide
* @returns {Promise<Message>}
* @example
* // Update the content of a message
Expand Down Expand Up @@ -646,7 +646,7 @@ class Message extends Base {

/**
* Send an inline reply to this message.
* @param {ReplyMessageOptions|MessageAdditions} options The additional options to provide
* @param {ReplyMessageOptions} options The additional options to provide
* @returns {Promise<Message|Message[]>}
* @example
* // Reply to a message
Expand Down
4 changes: 2 additions & 2 deletions src/structures/Webhook.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ class Webhook {

/**
* Sends a message with this webhook.
* @param {WebhookMessageOptions|MessageAdditions} options The options to provide
* @param {WebhookMessageOptions} options The options to provide
* @returns {Promise<Message|Object>}
* @example
* // Send a basic message
Expand Down Expand Up @@ -236,7 +236,7 @@ class Webhook {
/**
* Edits a message that was sent by this webhook.
* @param {MessageResolvable|'@original'} message The message to edit
* @param {WebhookEditMessageOptions|MessageAdditions} options The options to provide
* @param {WebhookEditMessageOptions} options The options to provide
* @returns {Promise<Message|Object>} Returns the raw message data if the webhook was instantiated as a
* {@link WebhookClient} or if the channel is uncached, otherwise a {@link Message} will be returned
*/
Expand Down
2 changes: 1 addition & 1 deletion src/structures/interfaces/TextBasedChannel.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ class TextBasedChannel {

/**
* Sends a message to this channel.
* @param {MessageOptions|MessageAdditions} options The options to provide
* @param {MessageOptions} options The options to provide
* @returns {Promise<Message|Message[]>}
* @example
* // Send a basic message
Expand Down
23 changes: 5 additions & 18 deletions typings/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1215,13 +1215,7 @@ declare module 'discord.js' {
options?: AwaitMessageComponentInteractionsOptions,
): MessageComponentInteractionCollector;
public delete(): Promise<Message>;
public edit(
content: string | null | MessageEditOptions | MessageEmbed | APIMessage | MessageAttachment | MessageAttachment[],
): Promise<Message>;
public edit(
content: string | null,
options: MessageEditOptions | MessageEmbed | MessageAttachment | MessageAttachment[],
): Promise<Message>;
public edit(options: MessageEditOptions): Promise<Message>;
public equals(message: Message, rawData: unknown): boolean;
public fetchReference(): Promise<Message>;
public fetchWebhook(): Promise<Webhook>;
Expand All @@ -1232,7 +1226,7 @@ declare module 'discord.js' {
public removeAttachments(): Promise<Message>;
public reply(options: ReplyMessageOptions & { split: true | SplitOptions }): Promise<Message[]>;
public reply(options: ReplyMessageOptions): Promise<Message | Message[]>;
public reply(options: (ReplyMessageOptions & { split?: false }) | MessageAdditions): Promise<Message>;
public reply(options: ReplyMessageOptions & { split?: false }): Promise<Message>;
public suppressEmbeds(suppress?: boolean): Promise<Message>;
public toJSON(): unknown;
public toString(): string;
Expand Down Expand Up @@ -2079,14 +2073,10 @@ declare module 'discord.js' {
public client: this;
public options: WebhookClientOptions;
public token: string;
public editMessage(message: MessageResolvable, options?: WebhookEditMessageOptions): Promise<RawMessage>;
public editMessage(message: MessageResolvable, options: WebhookEditMessageOptions): Promise<RawMessage>;
public fetchMessage(message: Snowflake, cache?: boolean): Promise<RawMessage>;
public send(
content: string | (WebhookMessageOptions & { split?: false }) | MessageAdditions,
): Promise<Message | RawMessage>;
public send(options: WebhookMessageOptions & { split: true | SplitOptions }): Promise<(Message | RawMessage)[]>;
public send(options: (WebhookMessageOptions & { split?: false }) | MessageAdditions): Promise<Message | RawMessage>;
public send(options: WebhookMessageOptions & { split?: false }): Promise<Message | RawMessage>;
public send(options: WebhookMessageOptions): Promise<Message | RawMessage | (Message | RawMessage)[]>;
}

Expand Down Expand Up @@ -2425,7 +2415,7 @@ declare module 'discord.js' {
lastMessageID: Snowflake | null;
readonly lastMessage: Message | null;
send(options: MessageOptions & { split: true | SplitOptions }): Promise<Message[]>;
send(options: (MessageOptions & { split?: false }) | MessageAdditions): Promise<Message>;
send(options: MessageOptions & { split?: false }): Promise<Message>;
}

interface TextBasedChannelFields extends PartialTextBasedChannelFields {
Expand Down Expand Up @@ -2476,11 +2466,8 @@ declare module 'discord.js' {
options: WebhookEditMessageOptions,
): Promise<Message | RawMessage>;
fetchMessage(message: Snowflake | '@original', cache?: boolean): Promise<Message | RawMessage>;
send(
content: string | (WebhookMessageOptions & { split?: false }) | MessageAdditions,
): Promise<Message | RawMessage>;
send(options: WebhookMessageOptions & { split: true | SplitOptions }): Promise<(Message | RawMessage)[]>;
send(options: (WebhookMessageOptions & { split?: false }) | MessageAdditions): Promise<Message | RawMessage>;
send(options: WebhookMessageOptions & { split?: false }): Promise<Message | RawMessage>;
send(options: WebhookMessageOptions): Promise<Message | RawMessage | (Message | RawMessage)[]>;
sendSlackMessage(body: unknown): Promise<boolean>;
}
Expand Down
4 changes: 2 additions & 2 deletions typings/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ client.on('message', ({ channel }) => {

const attachment = new MessageAttachment('file.png');
const embed = new MessageEmbed();
assertIsMessage(channel.send(attachment));
assertIsMessage(channel.send({ files: [attachment] }));
assertIsMessage(channel.send(embed));
assertIsMessage(channel.send([attachment, embed]));
assertIsMessage(channel.send({ files: [attachment], embed: embed }));

assertIsMessageArray(channel.send({ split: true }));

Expand Down

0 comments on commit e7bc965

Please sign in to comment.