{"id":16623632,"url":"https://github.com/catplvsplus/oceanic-collector","last_synced_at":"2025-08-31T20:32:43.746Z","repository":{"id":143299189,"uuid":"615347545","full_name":"catplvsplus/oceanic-collector","owner":"catplvsplus","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-23T07:38:19.000Z","size":39,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-09T12:44:04.681Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/catplvsplus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-17T13:45:45.000Z","updated_at":"2023-06-04T19:10:16.000Z","dependencies_parsed_at":"2023-05-12T01:45:23.460Z","dependency_job_id":null,"html_url":"https://github.com/catplvsplus/oceanic-collector","commit_stats":null,"previous_names":["catplvsplus/oceanic-collector","notghex/oceanic-collector"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/catplvsplus/oceanic-collector","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catplvsplus%2Foceanic-collector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catplvsplus%2Foceanic-collector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catplvsplus%2Foceanic-collector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catplvsplus%2Foceanic-collector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/catplvsplus","download_url":"https://codeload.github.com/catplvsplus/oceanic-collector/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catplvsplus%2Foceanic-collector/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273034814,"owners_count":25034472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-12T03:24:25.187Z","updated_at":"2025-08-31T20:32:43.710Z","avatar_url":"https://github.com/catplvsplus.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Oceanic Collector\nA collection of oceanic collectors\n\n- [Collector Usage](#collector-usage)\n- [Awaiter Usage](#awaiter-usage)\n\n\u003e See also [eris-collectors](https://www.npmjs.com/package/eris-collectors)\n\n```\nnpm i oceanic-collector\nyarn add oceanic-collector\npnpm add oceanic-collector\n```\n\n## Collector Usage\n\n```js\nconst { MessageCollector } = require('oceanic-collector');\n\nconst collector = new MessageCollector({\n    client: bot,                            // [Required] Your bot client\n    channel: channel,                       // [Required] Any text channel\n    time: 1000 * 60,                        // [Optional] Collector timeout in milliseconds\n    max: 10,                                // [Optional] Max collected messages\n    filter: message =\u003e !message.author.bot, // [Optional] Custom collector filter\n});\n\ncollector.on('collect', message =\u003e {}); // Emitted when the collector collects a message\ncollector.on('end', reason =\u003e {});      // Emitted when the collector stopped\n\ncollector.stop();                       // Stop collecting messages\n```\n\n```js\nconst { ReactionCollector } = require('oceanic-collector');\n\nconst collector = new ReactionCollector({\n    client: bot,                            // [Required] Your bot client\n    message: message,                       // [Required] A message to collect reactions from\n    time: 1000 * 60,                        // [Optional] Collector timeout in milliseconds\n    max: 10,                                // [Optional] Max collected reactions\n    maxEmojis: 10,                          // [Optional] Max collected emoji\n    maxReactors: 10,                        // [Optional] Max reactors\n    filter: reaction =\u003e true,               // [Optional] custom collector filter\n});\n\ncollector.on('collect', reaction =\u003e {}); // Emitted when the collector collects a reaction\ncollector.on('end', reason =\u003e {});       // Emitted when the collector stopped\n\ncollector.stop();                        // Stop collecting reactions\n```\n\n```js\nconst { InteractionCollector } = require('oceanic-collector');\nconst { InteractionTypes } = require('oceanic.js');\n\nconst collector = new InteractionCollector({\n    client: bot,                                         // [Required] Your bot client\n    message: message,                                    // [Optional] A message to collect interactions from\n    channel: channel,                                    // [Optional] Collects interactions in a channel\n    guild: guild,                                        // [Optional] Collects interactions from a guild\n    interactionType: InteractionTypes.MESSAGE_COMPONENT, // [Optional] Sets the interaction type to collect\n    maxUsers: maxUsers,                                  // [Optional] Set max users to interact to this collector\n    time: 1000 * 60,                                     // [Optional] Collector timeout in milliseconds\n    max: 10,                                             // [Optional] Max collected reactions\n    filter: interaction =\u003e true,                         // [Optional] custom collector filter\n});\n\ncollector.on('collect', interaction =\u003e {}); // Emitted when the collector collects an interaction\ncollector.on('end', reason =\u003e {});          // Emitted when the collector stopped\n\ncollector.stop();                           // Stop collecting interactions\n```\n\n## Awaiter Usage\n\n```js\nconst { awaitMessage } = require('oceanic-collector');\n\n// Single message\nconst message = await awaitMessage({ client, channel });\n\n// Multiple messages\nconst messages = await awaitMessage({ client, channel, max: 0 });\n```\n\n```js\nconst { awaitInteraction } = require('oceanic-collector');\n\n// Single interaction\nconst interaction = await awaitInteraction({ client, channel });\n\n// Multiple interactions\nconst interactions = await awaitInteraction({ client, channel, max: 0 });\n```\n\n```js\nconst { awaitReaction } = require('oceanic-collector');\n\n// Single reaction\nconst reaction = await awaitReaction({ client, channel });\n\n// Multiple reactions\nconst reactions = await awaitReaction({ client, channel, max: 0 });\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatplvsplus%2Foceanic-collector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatplvsplus%2Foceanic-collector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatplvsplus%2Foceanic-collector/lists"}