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

do more docs

Browse Source
This commit is contained in:
Amish Shah
2016-09-01 17:17:59 +01:00
parent df9cab3864
commit 43f1c952c3
2 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs.json
View File

File diff suppressed because one or more lines are too long

15
src/structures/interface/TextBasedChannel.js
View File

@@ -282,6 +282,14 @@ class TextBasedChannel {
* @param {CollectorFilterFunction} filter the filter to create the collector with * @param {CollectorFilterFunction} filter the filter to create the collector with
* @param {CollectorOptions} [options={}] the options to pass to the collector * @param {CollectorOptions} [options={}] the options to pass to the collector
* @returns {MessageCollector} * @returns {MessageCollector}
* @example
* // create a message collector
* const collector = channel.createCollector(
* m => m.content.includes('discord'),
* { time: 15000 }
* );
* collector.on('message', m => console.log(`Collected ${m.content}`));
* collector.on('end', collected => console.log(`Collected ${collected.size} items`));
*/ */
createCollector(filter, options = {}) { createCollector(filter, options = {}) {
const collector = new MessageCollector(this, filter, options); const collector = new MessageCollector(this, filter, options);
@@ -304,6 +312,13 @@ class TextBasedChannel {
* @param {CollectorFilterFunction} filter the filter function to use * @param {CollectorFilterFunction} filter the filter function to use
* @param {AwaitMessagesOptions} [options={}] optional options to pass to the internal collector * @param {AwaitMessagesOptions} [options={}] optional options to pass to the internal collector
* @returns {Promise<Collection<String, Message>>} * @returns {Promise<Collection<String, Message>>}
* @example
* // await !vote messages
* const filter = m => m.content.startsWith('!vote');
* // errors: ['time'] treats ending because of the time limit as an error
* channel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })
* .then(collected => console.log(collected.size))
* .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));
*/ */
awaitMessages(filter, options = {}) { awaitMessages(filter, options = {}) {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {