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

* mention order returned from API
* not left to right in text
This commit is contained in:
Souji
2020-01-14 11:28:19 +01:00
committed by SpaceEEC
parent 75fe1faf2f
commit 7f99be739a

View File

@@ -42,6 +42,7 @@ class MessageMentions {
if (users instanceof Collection) { if (users instanceof Collection) {
/** /**
* Any users that were mentioned * 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>} * @type {Collection<Snowflake, User>}
*/ */
this.users = new Collection(users); this.users = new Collection(users);
@@ -63,6 +64,7 @@ class MessageMentions {
if (roles instanceof Collection) { if (roles instanceof Collection) {
/** /**
* Any roles that were mentioned * 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>} * @type {Collection<Snowflake, Role>}
*/ */
this.roles = new Collection(roles); this.roles = new Collection(roles);
@@ -104,6 +106,7 @@ class MessageMentions {
if (crosspostedChannels instanceof Collection) { if (crosspostedChannels instanceof Collection) {
/** /**
* A collection of crossposted channels * 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>} * @type {Collection<Snowflake, CrosspostedChannel>}
*/ */
this.crosspostedChannels = new Collection(crosspostedChannels); this.crosspostedChannels = new Collection(crosspostedChannels);
@@ -127,6 +130,7 @@ class MessageMentions {
/** /**
* Any members that were mentioned (only in {@link TextChannel}s) * 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>} * @type {?Collection<Snowflake, GuildMember>}
* @readonly * @readonly
*/ */
@@ -143,6 +147,7 @@ class MessageMentions {
/** /**
* Any channels that were mentioned * 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>} * @type {Collection<Snowflake, GuildChannel>}
* @readonly * @readonly
*/ */