Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-09 16:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(MessageEmbed): MessageEmbedOptions typedef (#5466)

Browse Source 
Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>
This commit is contained in:
Rodry
2021-05-10 11:31:35 +01:00
committed by GitHub
parent eaf332f83f
commit 4a06dd1295
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/structures/MessageEmbed.js
View File

@@ -11,7 +11,24 @@ class MessageEmbed {
* @name MessageEmbed
* @kind constructor
* @memberof MessageEmbed
* @param {MessageEmbed|Object} [data={}] MessageEmbed to clone or raw embed data
* @param {MessageEmbed|MessageEmbedOptions} [data={}] MessageEmbed to clone or raw embed data
*/
/**
* Represents the possible options for a MessageEmbed
* @typedef {Object} MessageEmbedOptions
* @property {string} [title] The title of this embed
* @property {string} [description] The description of this embed
* @property {string} [url] The URL of this embed
* @property {Date|number} [timestamp] The timestamp of this embed
* @property {ColorResolvable} [color] The color of this embed
* @property {EmbedFieldData[]} [fields] The fields of this embed
* @property {Array<FileOptions|string|MessageAttachment>} [files] The files of this embed
* @property {Partial<MessageEmbedAuthor>} [author] The author of this embed
* @property {Partial<MessageEmbedThumbnail>} [thumbnail] The thumbnail of this embed
* @property {Partial<MessageEmbedImage>} [image] The image of this embed
* @property {Partial<MessageEmbedVideo>} [video] The video of this embed
* @property {Partial<MessageEmbedFooter>} [footer] The footer of this embed
*/
constructor(data = {}, skipValidation = false) {