docs(MessageMentions): add sort order notice (#3693)

* mention order returned from API * not left to right in text
discordjs · Jan 14, 2020 · 7f99be7 · 7f99be7
1 parent 75fe1fa
commit 7f99be7
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/structures/MessageMentions.js b/src/structures/MessageMentions.js
@@ -42,6 +42,7 @@ class MessageMentions {
       if (users instanceof Collection) {
         /**
          * Any users that were mentioned
+         * <info>Order as received from the API, not left to right by occurence in the message content</info>
          * @type {Collection<Snowflake, User>}
          */
         this.users = new Collection(users);
@@ -63,6 +64,7 @@ class MessageMentions {
       if (roles instanceof Collection) {
         /**
          * Any roles that were mentioned
+         * <info>Order as received from the API, not left to right by occurence in the message content</info>
          * @type {Collection<Snowflake, Role>}
          */
         this.roles = new Collection(roles);
@@ -104,6 +106,7 @@ class MessageMentions {
       if (crosspostedChannels instanceof Collection) {
         /**
          * A collection of crossposted channels
+         * <info>Order as received from the API, not left to right by occurence in the message content</info>
          * @type {Collection<Snowflake, CrosspostedChannel>}
          */
         this.crosspostedChannels = new Collection(crosspostedChannels);
@@ -127,6 +130,7 @@ class MessageMentions {
 
   /**
    * Any members that were mentioned (only in {@link TextChannel}s)
+   * <info>Order as received from the API, not left to right by occurence in the message content</info>
    * @type {?Collection<Snowflake, GuildMember>}
    * @readonly
    */
@@ -143,6 +147,7 @@ class MessageMentions {
 
   /**
    * Any channels that were mentioned
+   * <info>Order as received from the API, not left to right by occurence in the message content</info>
    * @type {Collection<Snowflake, GuildChannel>}
    * @readonly
    */