@sern/handler/dist/core/modules.d.ts

A complete, customizable, typesafe, & reactive framework for discord bots.

import type { ClientEvents } from 'discord.js';
import type { InputCommand, InputEvent, Module, ScheduledTask } from '../types/core-modules';
import type { Awaitable } from '../types/utility';
/**
 * Creates a command module with standardized structure and plugin support.
 *
 * @since 1.0.0
 * @param {InputCommand} mod - Command module configuration
 * @returns {Module} Processed command module ready for registration
 *
 * @example
 * // Basic slash command
 * export default commandModule({
 *   type: CommandType.Slash,
 *   description: "Ping command",
 *   execute: async (ctx) => {
 *     await ctx.reply("Pong! 🏓");
 *   }
 * });
 *
 * @example
 * // Command with component interaction
 * export default commandModule({
 *   type: CommandType.Slash,
 *   description: "Interactive command",
 *   execute: async (ctx) => {
 *     const button = new ButtonBuilder({
 *       customId: "btn/someData",
 *       label: "Click me",
 *       style: ButtonStyle.Primary
 *     });
 *     await ctx.reply({
 *       content: "Interactive message",
 *       components: [new ActionRowBuilder().addComponents(button)]
 *     });
 *   }
 * });
 */
export declare function commandModule(mod: InputCommand): Module;
/**
 * Creates an event module for handling Discord.js or custom events.
 *
 * @since 1.0.0
 * @template T - Event name from ClientEvents
 * @param {InputEvent<T>} mod - Event module configuration
 * @returns {Module} Processed event module ready for registration
 * @throws {Error} If ControlPlugins are used in event modules
 *
 * @example
 * // Discord event listener
 * export default eventModule({
 *   type: EventType.Discord,
 *   execute: async (message) => {
 *     console.log(`${message.author.tag}: ${message.content}`);
 *   }
 * });
 *
 * @example
 * // Custom sern event
 * export default eventModule({
 *   type: EventType.Sern,
 *   execute: async (eventData) => {
 *     // Handle sern-specific event
 *   }
 * });
 */
export declare function eventModule<T extends keyof ClientEvents = keyof ClientEvents>(mod: InputEvent<T>): Module;
/** Create event modules from discord.js client events,
 * This was an {@link eventModule} for discord events,
 * where typings were bad.
 * @deprecated Use {@link eventModule} instead
 * @param mod
 */
export declare function discordEvent<T extends keyof ClientEvents>(mod: {
    name: T;
    once?: boolean;
    execute: (...args: ClientEvents[T]) => Awaitable<unknown>;
}): Module;
/**
 * Creates a scheduled task that can be executed at specified intervals using cron patterns
 *
 * @param {ScheduledTask} ism - The scheduled task configuration object
 * @param {string} ism.trigger - A cron pattern that determines when the task should execute
 *                              Format: "* * * * *" (minute hour day month day-of-week)
 * @param {Function} ism.execute - The function to execute when the task is triggered
 * @param {Object} ism.execute.context - The execution context passed to the task
 *
 * @returns {ScheduledTask} The configured scheduled task
 *
 * @example
 * // Create a task that runs every minute
 * export default scheduledTask({
 *   trigger: "* * * * *",
 *   execute: (context) => {
 *     console.log("Task executed!");
 *   }
 * });
 *
 * @remarks
 * - Tasks must be placed in the 'tasks' directory specified in your config
 * - The file name serves as a unique identifier for the task
 * - Tasks can be cancelled using deps['@sern/scheduler'].kill(uuid)
 *
 * @see {@link https://crontab.guru/} for testing and creating cron patterns
 */
export declare function scheduledTask(ism: ScheduledTask): ScheduledTask;