meocord/dist/decorator/command-builder.decorator.d.ts

MeoCord is a lightweight and modular framework for building scalable Discord bots using TypeScript and Discord.js. It simplifies bot development with an extensible architecture, TypeScript-first approach, and powerful CLI tools.

/**
 * MeoCord Framework
 * Copyright (C) 2025 Ukasyah Rahmatullah Zada
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
import 'reflect-metadata';
import { CommandType } from '../enum/index.js';
import { type CommandBuilderBase } from '../interface/command-decorator.interface.js';
/**
 * This decorator is used to mark a class as a Discord command builder that later can be registered on the `@Command` decorator.
 * It defines the command type using metadata and dynamically makes the class injectable if it isn't already.
 *
 * @example
 * ```typescript
 * @CommandBuilder(CommandType.SLASH)
 * export class MySlashCommand implements CommandBuilderBase {
 *   build(commandName: string): SlashCommandBuilder {
 *     return new SlashCommandBuilder().setName(commandName).setDescription('A sample slash command')
 *   }
 * }
 *```
 *
 * @param commandType - The type of the command, specified from the `CommandType` enum.
 * @returns A decorator function that makes the target class injectable
 *          and assigns the `commandType` metadata.
 */
export declare function CommandBuilder<T extends CommandType.SLASH | CommandType.CONTEXT_MENU>(commandType: T): (target: new () => CommandBuilderBase<T>) => void;