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

docs(Embeds): Added descriptions to the typedefs (#4303)

Browse Source 
Co-authored-by: RDambrosio <rdambrosio016@gmail.com>
This commit is contained in:
Sardonyx
2020-08-12 13:29:02 +03:00
committed by GitHub
parent 57ca3d7843
commit 2a7f749d5a
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/structures/MessageEmbed.js
View File

@@ -62,6 +62,7 @@ class MessageEmbed {
this.timestamp = data.timestamp ? new Date(data.timestamp).getTime() : null; this.timestamp = data.timestamp ? new Date(data.timestamp).getTime() : null;
/** /**
* Represents a field of a MessageEmbed
* @typedef {Object} EmbedField * @typedef {Object} EmbedField
* @property {string} name The name of this field * @property {string} name The name of this field
* @property {string} value The value of this field * @property {string} value The value of this field
@@ -78,6 +79,7 @@ class MessageEmbed {
} }
/** /**
* Represents the thumbnail of a MessageEmbed
* @typedef {Object} MessageEmbedThumbnail * @typedef {Object} MessageEmbedThumbnail
* @property {string} url URL for this thumbnail * @property {string} url URL for this thumbnail
* @property {string} proxyURL ProxyURL for this thumbnail * @property {string} proxyURL ProxyURL for this thumbnail
@@ -99,6 +101,7 @@ class MessageEmbed {
: null; : null;
/** /**
* Represents the image of a MessageEmbed
* @typedef {Object} MessageEmbedImage * @typedef {Object} MessageEmbedImage
* @property {string} url URL for this image * @property {string} url URL for this image
* @property {string} proxyURL ProxyURL for this image * @property {string} proxyURL ProxyURL for this image
@@ -120,6 +123,7 @@ class MessageEmbed {
: null; : null;
/** /**
* Represents the video of a MessageEmbed
* @typedef {Object} MessageEmbedVideo * @typedef {Object} MessageEmbedVideo
* @property {string} url URL of this video * @property {string} url URL of this video
* @property {string} proxyURL ProxyURL for this video * @property {string} proxyURL ProxyURL for this video
@@ -142,6 +146,7 @@ class MessageEmbed {
: null; : null;
/** /**
* Represents the author field of a MessageEmbed
* @typedef {Object} MessageEmbedAuthor * @typedef {Object} MessageEmbedAuthor
* @property {string} name The name of this author * @property {string} name The name of this author
* @property {string} url URL of this author * @property {string} url URL of this author
@@ -163,6 +168,7 @@ class MessageEmbed {
: null; : null;
/** /**
* Represents the provider of a MessageEmbed
* @typedef {Object} MessageEmbedProvider * @typedef {Object} MessageEmbedProvider
* @property {string} name The name of this provider * @property {string} name The name of this provider
* @property {string} url URL of this provider * @property {string} url URL of this provider
@@ -180,6 +186,7 @@ class MessageEmbed {
: null; : null;
/** /**
* Represents the footer field of a MessageEmbed
* @typedef {Object} MessageEmbedFooter * @typedef {Object} MessageEmbedFooter
* @property {string} text The text of this footer * @property {string} text The text of this footer
* @property {string} iconURL URL of the icon for this footer * @property {string} iconURL URL of the icon for this footer