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

docs(Formatters): Use id over ID (#6439)

Browse Source
This commit is contained in:
Jiralite
2021-08-15 12:08:06 +01:00
committed by GitHub
parent 71fdf6fae0
commit 84bb4f4153
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/util/Formatters.js
View File

@@ -45,10 +45,10 @@ Formatters.blockQuote = blockQuote;
Formatters.bold = bold; Formatters.bold = bold;
/** /**
* Formats a channel ID into a channel mention. * Formats a channel id into a channel mention.
* @method channelMention * @method channelMention
* @memberof Formatters * @memberof Formatters
* @param {string} channelId The channel ID to format. * @param {string} channelId The channel id to format.
* @returns {string} * @returns {string}
*/ */
Formatters.channelMention = channelMention; Formatters.channelMention = channelMention;
@@ -64,10 +64,10 @@ Formatters.channelMention = channelMention;
Formatters.codeBlock = codeBlock; Formatters.codeBlock = codeBlock;
/** /**
* Formats an emoji ID into a fully qualified emoji identifier * Formats an emoji id into a fully qualified emoji identifier
* @method formatEmoji * @method formatEmoji
* @memberof Formatters * @memberof Formatters
* @param {string} emojiId The emoji ID to format. * @param {string} emojiId The emoji id to format.
* @param {boolean} [animated] Whether the emoji is animated or not. Defaults to `false` * @param {boolean} [animated] Whether the emoji is animated or not. Defaults to `false`
* @returns {string} * @returns {string}
*/ */
@@ -112,10 +112,10 @@ Formatters.inlineCode = inlineCode;
Formatters.italic = italic; Formatters.italic = italic;
/** /**
* Formats a user ID into a member-nickname mention. * Formats a user id into a member-nickname mention.
* @method memberNicknameMention * @method memberNicknameMention
* @memberof Formatters * @memberof Formatters
* @param {string} memberId The user ID to format. * @param {string} memberId The user id to format.
* @returns {string} * @returns {string}
*/ */
Formatters.memberNicknameMention = memberNicknameMention; Formatters.memberNicknameMention = memberNicknameMention;
@@ -130,10 +130,10 @@ Formatters.memberNicknameMention = memberNicknameMention;
Formatters.quote = quote; Formatters.quote = quote;
/** /**
* Formats a role ID into a role mention. * Formats a role id into a role mention.
* @method roleMention * @method roleMention
* @memberof Formatters * @memberof Formatters
* @param {string} roleId The role ID to format. * @param {string} roleId The role id to format.
* @returns {string} * @returns {string}
*/ */
Formatters.roleMention = roleMention; Formatters.roleMention = roleMention;
@@ -197,10 +197,10 @@ Formatters.TimestampStyles = TimestampStyles;
Formatters.underscore = underscore; Formatters.underscore = underscore;
/** /**
* Formats a user ID into a user mention. * Formats a user id into a user mention.
* @method userMention * @method userMention
* @memberof Formatters * @memberof Formatters
* @param {string} userId The user ID to format. * @param {string} userId The user id to format.
* @returns {string} * @returns {string}
*/ */
Formatters.userMention = userMention; Formatters.userMention = userMention;