notghex / oceanic-collector

Oceanic Collector

A collection of oceanic collectors

• Collector Usage
• Awaiter Usage

See also eris-collectors

npm i oceanic-collector
yarn add oceanic-collector
pnpm add oceanic-collector

Collector Usage

const { MessageCollector } = require('oceanic-collector');

const collector = new MessageCollector({
    client: bot,                            // [Required] Your bot client
    channel: channel,                       // [Required] Any text channel
    time: 1000 * 60,                        // [Optional] Collector timeout in milliseconds
    max: 10,                                // [Optional] Max collected messages
    filter: message => !message.author.bot, // [Optional] Custom collector filter
});

collector.on('collect', message => {}); // Emitted when the collector collects a message
collector.on('end', reason => {});      // Emitted when the collector stopped

collector.stop();                       // Stop collecting messages

const { ReactionCollector } = require('oceanic-collector');

const collector = new ReactionCollector({
    client: bot,                            // [Required] Your bot client
    message: message,                       // [Required] A message to collect reactions from
    time: 1000 * 60,                        // [Optional] Collector timeout in milliseconds
    max: 10,                                // [Optional] Max collected reactions
    maxEmojis: 10,                          // [Optional] Max collected emoji
    maxReactors: 10,                        // [Optional] Max reactors
    filter: reaction => true,               // [Optional] custom collector filter
});

collector.on('collect', reaction => {}); // Emitted when the collector collects a reaction
collector.on('end', reason => {});       // Emitted when the collector stopped

collector.stop();                        // Stop collecting reactions

const { InteractionCollector } = require('oceanic-collector');
const { InteractionTypes } = require('oceanic.js');

const collector = new InteractionCollector({
    client: bot,                                         // [Required] Your bot client
    message: message,                                    // [Optional] A message to collect interactions from
    channel: channel,                                    // [Optional] Collects interactions in a channel
    guild: guild,                                        // [Optional] Collects interactions from a guild
    interactionType: InteractionTypes.MESSAGE_COMPONENT, // [Optional] Sets the interaction type to collect
    maxUsers: maxUsers,                                  // [Optional] Set max users to interact to this collector
    time: 1000 * 60,                                     // [Optional] Collector timeout in milliseconds
    max: 10,                                             // [Optional] Max collected reactions
    filter: interaction => true,                         // [Optional] custom collector filter
});

collector.on('collect', interaction => {}); // Emitted when the collector collects an interaction
collector.on('end', reason => {});          // Emitted when the collector stopped

collector.stop();                           // Stop collecting interactions

Awaiter Usage

const { awaitMessage } = require('oceanic-collector');

// Single message
const message = await awaitMessage({ client, channel });

// Multiple messages
const messages = await awaitMessage({ client, channel, max: 0 });

const { awaitInteraction } = require('oceanic-collector');

// Single interaction
const interaction = await awaitInteraction({ client, channel });

// Multiple interactions
const interactions = await awaitInteraction({ client, channel, max: 0 });

const { awaitReaction } = require('oceanic-collector');

// Single reaction
const reaction = await awaitReaction({ client, channel });

// Multiple reactions
const reactions = await awaitReaction({ client, channel, max: 0 });