feat(*): document and support embeds field in message create endpoint (#5792)

Co-authored-by: ckohen <chaikohen@gmail.com>
Co-authored-by: Jan <66554238+vaporox@users.noreply.github.com>
This commit is contained in:
Adrian Castro
2021-06-12 00:45:17 +02:00
committed by GitHub
parent 6df36232a0
commit 99ff715137
4 changed files with 26 additions and 18 deletions

7
typings/index.d.ts vendored
View File

@@ -3256,7 +3256,7 @@ declare module 'discord.js' {
interface MessageEditOptions {
attachments?: MessageAttachment[];
content?: string | null;
embed?: MessageEmbed | MessageEmbedOptions | null;
embeds?: (MessageEmbed | MessageEmbedOptions)[] | null;
code?: string | boolean;
files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[];
flags?: BitFieldResolvable<MessageFlagsString, number>;
@@ -3352,7 +3352,7 @@ declare module 'discord.js' {
tts?: boolean;
nonce?: string | number;
content?: string;
embed?: MessageEmbed | MessageEmbedOptions;
embeds?: (MessageEmbed | MessageEmbedOptions)[];
components?: MessageActionRow[] | MessageActionRowOptions[] | MessageActionRowComponentResolvable[][];
allowedMentions?: MessageMentionOptions;
files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[];
@@ -3754,10 +3754,9 @@ declare module 'discord.js' {
'content' | 'embeds' | 'files' | 'allowedMentions' | 'components'
>;
interface WebhookMessageOptions extends Omit<MessageOptions, 'embed' | 'reply'> {
interface WebhookMessageOptions extends Omit<MessageOptions, 'reply'> {
username?: string;
avatarURL?: string;
embeds?: (MessageEmbed | unknown)[];
}
type WebhookTypes = 'Incoming' | 'Channel Follower';

View File

@@ -34,13 +34,13 @@ declare const assertIsMessageArray: (m: Promise<Message[]>) => void;
client.on('message', ({ channel }) => {
assertIsMessage(channel.send('string'));
assertIsMessage(channel.send({}));
assertIsMessage(channel.send({ embed: {} }));
assertIsMessage(channel.send({ embeds: [] }));
const attachment = new MessageAttachment('file.png');
const embed = new MessageEmbed();
assertIsMessage(channel.send({ files: [attachment] }));
assertIsMessage(channel.send({ embed }));
assertIsMessage(channel.send({ embed, files: [attachment] }));
assertIsMessage(channel.send({ embeds: [embed] }));
assertIsMessage(channel.send({ embeds: [embed], files: [attachment] }));
assertIsMessageArray(channel.send({ split: true }));