\n\n## About\n\n`@reciple/modules` A JSX wrapper for [Discord.js](https://discord.js.org/) builders.\n\n## Installation\n\n```bash\nnpm install @reciple/modules\nyarn add @reciple/modules\npnpm add @reciple/modules\nbun install @reciple/modules\ndeno install npm:@reciple/modules\n```\n\n## Usage\n\nCreate a new reciple module file then create a new module instance as the default export.\n\n### Anticrash\n\nA module that catches process and client errors that cause the bot to crash then logs them to a channel if specified.\n\n```js\n// example/src/addons/antiCrash.js\nimport { RecipleAnticrash } from '@reciple/modules';\n\nexport default new RecipleAnticrash({\n // The channels to report errors to\n reportChannels: ['000000000000000000'],\n\n // The base options for the report message\n baseReportMessageOptions: {\n content: 'An error has occurred!',\n }\n});\n```\n\n### Registry Cache\n\nA module that caches the application commands to prevent unnecessary requests to the Discord API when registering commands that haven't changed.\n\n```js\n// example/src/addons/registryCache.js\nimport { RecipleRegistryCache } from '@reciple/modules';\n\nexport default new RecipleRegistryCache({\n // Cache duration in milliseconds\n maxCacheAgeMs: 24 * 60 * 60 * 1000,\n\n // The directory to store the cache in\n cacheDir: '.cache/reciple-registry/',\n\n // The environment variable to check if the cache is enabled\n cacheEnabledEnv: 'RECIPLE_REGISTRY_CACHE',\n\n // Create a cache entry even if the cache is disabled\n createCacheEntryEvenIfDisabled: true\n});\n```\n\n### Interaction Events\n\nA module that handles interaction events and executes listeners based on the interaction type. The listeners are resolved from the specified module property.\n\n```js\n// example/src/addons/interactionEvents.js\nimport { RecipleInteractionEvents } from '@reciple/modules';\n\nexport default new RecipleInteractionEvents({\n // Filters the modules to resolve listeners from\n ignoredModules: (module) => module.id === 'ignored_id',\n\n // The module property to resolve listeners from\n moduleEventListenersProperty: ['interactions']\n});\n```\n\n```js\n// example/src/commands/ping.js\nimport { InteractionListenerBuilder, InteractionListenerType } from '@reciple/modules';\nimport { ActionRowBuilder, ButtonBuilder, ButtonStyle } from 'discord.js';\nimport { SlashCommandBuilder, SlashCommandModule, type SlashCommand } from 'reciple';\n\nexport class ButtonPingCommand extends SlashCommandModule {\n data = new SlashCommandBuilder()\n .setName('ping')\n .setDescription('Test ping command')\n .toJSON();\n\n /**\n * @type {InteractionListenerBuilder[]}\n */\n interactions = [\n new InteractionListenerBuilder()\n .setType(InteractionListenerType.Button)\n .setFilter(interaction => interaction.customId === 'ping')\n .setExecute(async interaction => {\n await interaction.reply({\n content: 'Pong!',\n ephemeral: true\n });\n })\n ];\n\n /**\n * @param {SlashCommand.ExecuteData} data\n */\n async execute(data) {\n await data.interaction.reply({\n components: [\n new ActionRowBuilder()\n .addComponents(\n new ButtonBuilder()\n .setCustomId('ping')\n .setLabel('Ping')\n .setStyle(ButtonStyle.Primary)\n )\n ]\n });\n }\n}\n\nexport default new ButtonPingCommand();\n```\n\n## Links\n\n- [Website](https://reciple.js.org)\n- [Discord](https://discord.gg/KxfPZYuTGV)\n- [Github](https://github.com/reciplejs/reciple/tree/main/packages/modules)\n- [NPM](https://npmjs.org/package/@reciple/modules)\n","readmeFilename":"README.md"}
![](\"https://i.imgur.com/C3gWxwc.png\")
\n ![](\"https://img.shields.io/discord/1453743492722458708?color=5865F2&logo=discord&logoColor=white\")
\n \n \n ![](\"https://img.shields.io/npm/v/@reciple/modules?label=npm\")
\n \n \n ![](\"https://img.shields.io/npm/dt/@reciple/modules?maxAge=3600\")
\n \n \n