mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-13 18:13:29 +01:00
Make JSDocs follow general conventions (#582)
* Make JSDocs follow usual conventions * Fix StringResolvable name * Make function lowercase
This commit is contained in:
committed by
Amish Shah
parent
44efcf3f52
commit
27652b94af
@@ -22,30 +22,30 @@ class Emoji {
|
||||
setup(data) {
|
||||
/**
|
||||
* The ID of the Emoji
|
||||
* @type {String}
|
||||
* @type {string}
|
||||
*/
|
||||
this.id = data.id;
|
||||
/**
|
||||
* The name of the Emoji
|
||||
* @type {String}
|
||||
* @type {string}
|
||||
*/
|
||||
this.name = data.name;
|
||||
this.roleIDS = data.roles;
|
||||
/**
|
||||
* Whether or not this emoji requires colons surrounding it
|
||||
* @type {Boolean}
|
||||
* @type {boolean}
|
||||
*/
|
||||
this.requiresColons = data.require_colons;
|
||||
/**
|
||||
* Whether this emoji is managed by an external service
|
||||
* @type {Boolean}
|
||||
* @type {boolean}
|
||||
*/
|
||||
this.managed = data.managed;
|
||||
}
|
||||
|
||||
/**
|
||||
* A collection of roles this emoji is active for (empty if all). Mapped by role ID.
|
||||
* @type {Collection<String, Role>}
|
||||
* @type {Collection<string, Role>}
|
||||
* @readonly
|
||||
*/
|
||||
get roles() {
|
||||
@@ -60,7 +60,7 @@ class Emoji {
|
||||
|
||||
/**
|
||||
* The URL to the emoji file
|
||||
* @type {String}
|
||||
* @type {string}
|
||||
* @readonly
|
||||
*/
|
||||
get url() {
|
||||
@@ -69,7 +69,7 @@ class Emoji {
|
||||
|
||||
/**
|
||||
* When concatenated with a String, this automatically returns the emoji mention rather than the object.
|
||||
* @returns {String}
|
||||
* @returns {string}
|
||||
* @example
|
||||
* // send an emoji:
|
||||
* const emoji = guild.emojis.array()[0];
|
||||
|
||||
Reference in New Issue
Block a user