From 069dccfa3b34e1778c9f0bde38bf272e5d966efe Mon Sep 17 00:00:00 2001 From: Frangu Vlad Date: Sat, 3 Mar 2018 12:04:33 +0200 Subject: [PATCH] docs: document the messages property for all TextBasedChannels (#2373) * Document TextChannel#messages * Same for DMChannels * And GroupDMChannels --- src/structures/DMChannel.js | 4 ++++ src/structures/GroupDMChannel.js | 4 ++++ src/structures/TextChannel.js | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/src/structures/DMChannel.js b/src/structures/DMChannel.js index 0567b98d4..20cb8a606 100644 --- a/src/structures/DMChannel.js +++ b/src/structures/DMChannel.js @@ -10,6 +10,10 @@ const MessageStore = require('../stores/MessageStore'); class DMChannel extends Channel { constructor(client, data) { super(client, data); + /** + * A collection containing the messages sent to this channel + * @type {MessageStore} + */ this.messages = new MessageStore(this); this._typing = new Map(); } diff --git a/src/structures/GroupDMChannel.js b/src/structures/GroupDMChannel.js index 4868fbbb9..1919ea575 100644 --- a/src/structures/GroupDMChannel.js +++ b/src/structures/GroupDMChannel.js @@ -34,6 +34,10 @@ const MessageStore = require('../stores/MessageStore'); class GroupDMChannel extends Channel { constructor(client, data) { super(client, data); + /** + * A collection containing the messages sent to this channel + * @type {MessageStore} + */ this.messages = new MessageStore(this); this._typing = new Map(); } diff --git a/src/structures/TextChannel.js b/src/structures/TextChannel.js index 2c512dcee..6c5db54c0 100644 --- a/src/structures/TextChannel.js +++ b/src/structures/TextChannel.js @@ -13,6 +13,10 @@ const MessageStore = require('../stores/MessageStore'); class TextChannel extends GuildChannel { constructor(guild, data) { super(guild, data); + /** + * A collection containing the messages sent to this channel + * @type {MessageStore} + */ this.messages = new MessageStore(this); this._typing = new Map(); }