Skip to content

types(MessageEditOptions): Correct attachments type #9874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 9, 2023
Merged

types(MessageEditOptions): Correct attachments type #9874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a8b247
types(MessageEditOptions): fix `attachments` type
Jiralite Oct 6, 2023
287d9ce
Merge branch 'main' into types/attachment-edit-data
kodiakhq[bot] Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions packages/discord.js/src/managers/MessageManager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,11 +152,17 @@ class MessageManager extends CachedManager {
* @returns {?Snowflake}
*/

/**
* Data used to reference an attachment.
* @typedef {Object} MessageEditAttachmentData
* @property {Snowflake} id The id of the attachment
*/

/**
* Options that can be passed to edit a message.
* @typedef {BaseMessageOptions} MessageEditOptions
* @property {AttachmentPayload[]} [attachments] An array of attachments to keep,
* all attachments will be kept if omitted
* @property {Array<Attachment|MessageEditAttachmentData>} [attachments] An array of attachments to keep.
* All attachments will be kept if omitted
* @property {MessageFlags} [flags] Which flags to set for the message
* <info>Only the {@link MessageFlags.SuppressEmbeds} flag can be modified.</info>
*/
Expand Down
6 changes: 5 additions & 1 deletion packages/discord.js/typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6003,9 +6003,13 @@ export interface MessageCreateOptions extends BaseMessageOptions {
export type GuildForumThreadMessageCreateOptions = BaseMessageOptions &
Pick<MessageCreateOptions, 'flags' | 'stickers'>;

export interface MessageEditAttachmentData {
id: Snowflake;
}

export interface MessageEditOptions extends Omit<BaseMessageOptions, 'content'> {
content?: string | null;
attachments?: JSONEncodable<AttachmentPayload>[];
attachments?: (Attachment | MessageEditAttachmentData)[];
flags?: BitFieldResolvable<Extract<MessageFlagsString, 'SuppressEmbeds'>, MessageFlags.SuppressEmbeds>;
}

Expand Down