necord 6.6.1 → 6.7.0

package/dist/commands/command.discovery.d.ts

@@ -3,9 +3,27 @@ import { NecordBaseDiscovery } from '../context';
 export interface BaseCommandMeta extends BaseApplicationCommandData {
     guilds?: Snowflake[];
 }
+/**
+ * Represents a command discovery.
+ * @abstract
+ * @url https://necord.org/interactions/slash-commands
+ */
 export declare abstract class CommandDiscovery<T extends BaseCommandMeta = BaseCommandMeta> extends NecordBaseDiscovery<T> {
+    /**
+     * Returns the command name.
+     */
     getName(): string;
+    /**
+     * Sets the command guilds for register.
+     * @param guilds
+     */
     setGuilds(guilds: Snowflake[]): void;
+    /**
+     * Checks if the command has a guild.
+     */
     hasGuild(guild: Snowflake): boolean;
+    /**
+     * Returns the guilds.
+     */
     getGuilds(): Snowflake[];
 }

package/dist/commands/command.discovery.js

@@ -2,17 +2,35 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandDiscovery = void 0;
 const context_1 = require("../context");
+/**
+ * Represents a command discovery.
+ * @abstract
+ * @url https://necord.org/interactions/slash-commands
+ */
 class CommandDiscovery extends context_1.NecordBaseDiscovery {
+    /**
+     * Returns the command name.
+     */
     getName() {
         return this.meta.name;
     }
+    /**
+     * Sets the command guilds for register.
+     * @param guilds
+     */
     setGuilds(guilds) {
         this.meta.guilds = guilds;
     }
+    /**
+     * Checks if the command has a guild.
+     */
     hasGuild(guild) {
         var _a;
         return (_a = this.meta.guilds) === null || _a === void 0 ? void 0 : _a.includes(guild);
     }
+    /**
+     * Returns the guilds.
+     */
     getGuilds() {
         return this.meta.guilds;
     }

package/dist/commands/commands.service.d.ts

@@ -2,13 +2,25 @@ import { Client, Collection } from 'discord.js';
 import { CommandDiscovery } from './command.discovery';
 import { ContextMenusService } from './context-menus';
 import { SlashCommandsService } from './slash-commands';
+/**
+ * Represents a service that manages commands.
+ * @url https://necord.org/interactions/slash-commands
+ */
 export declare class CommandsService {
     private readonly client;
     private readonly contextMenusService;
     private readonly slashCommandsService;
     private readonly logger;
     constructor(client: Client, contextMenusService: ContextMenusService, slashCommandsService: SlashCommandsService);
+    /**
+     * Registers all commands.
+     *
+     */
     registerAllCommands(): Promise<void>;
+    /**
+     * Registers commands in a guild.
+     * @param guildId
+     */
     registerInGuild(guildId: string): Promise<void | Collection<string, import("discord.js").ApplicationCommand<{}>>>;
     getCommands(): CommandDiscovery[];
     getCommandsByGuilds(): Collection<string, CommandDiscovery[]>;

package/dist/commands/commands.service.js

@@ -24,6 +24,10 @@ const common_1 = require("@nestjs/common");
 const discord_js_1 = require("discord.js");
 const context_menus_1 = require("./context-menus");
 const slash_commands_1 = require("./slash-commands");
+/**
+ * Represents a service that manages commands.
+ * @url https://necord.org/interactions/slash-commands
+ */
 let CommandsService = CommandsService_1 = class CommandsService {
     constructor(client, contextMenusService, slashCommandsService) {
         this.client = client;
@@ -31,6 +35,10 @@ let CommandsService = CommandsService_1 = class CommandsService {
         this.slashCommandsService = slashCommandsService;
         this.logger = new common_1.Logger(CommandsService_1.name);
     }
+    /**
+     * Registers all commands.
+     *
+     */
     registerAllCommands() {
         return __awaiter(this, void 0, void 0, function* () {
             const guilds = new Set(this.getCommandsByGuilds().keys());
@@ -41,6 +49,10 @@ let CommandsService = CommandsService_1 = class CommandsService {
             this.logger.log(`Successfully reloaded application commands.`);
         });
     }
+    /**
+     * Registers commands in a guild.
+     * @param guildId
+     */
     registerInGuild(guildId) {
         return __awaiter(this, void 0, void 0, function* () {
             const commands = this.getGuildCommands(guildId);

package/dist/commands/context-menus/context-menu.discovery.d.ts

@@ -1,11 +1,32 @@
 import { ContextMenuCommandInteraction, MessageApplicationCommandData, Snowflake, UserApplicationCommandData } from 'discord.js';
 import { CommandDiscovery } from '../command.discovery';
+/**
+ * The context menu metadata.
+ */
 export type ContextMenuMeta = (MessageApplicationCommandData | UserApplicationCommandData) & {
     guilds?: Snowflake[];
 };
+/**
+ * The context menu discovery.
+ * @see CommandDiscovery
+ * @see ContextMenuMeta
+ */
 export declare class ContextMenuDiscovery extends CommandDiscovery<ContextMenuMeta> {
+    /**
+     * Gets the discovery type.
+     */
     getType(): import("discord.js").ApplicationCommandType.User | import("discord.js").ApplicationCommandType.Message;
+    /**
+     * Type guard for the context menu discovery.
+     */
     isContextMenu(): this is ContextMenuDiscovery;
+    /**
+     * Executes the context menu discovery.
+     * @param interaction The interaction to execute.
+     */
     execute(interaction: ContextMenuCommandInteraction): any;
+    /**
+     * Converts the context menu discovery to JSON.
+     */
     toJSON(): ContextMenuMeta;
 }

package/dist/commands/context-menus/context-menu.discovery.js

@@ -2,16 +2,34 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContextMenuDiscovery = void 0;
 const command_discovery_1 = require("../command.discovery");
+/**
+ * The context menu discovery.
+ * @see CommandDiscovery
+ * @see ContextMenuMeta
+ */
 class ContextMenuDiscovery extends command_discovery_1.CommandDiscovery {
+    /**
+     * Gets the discovery type.
+     */
     getType() {
         return this.meta.type;
     }
+    /**
+     * Type guard for the context menu discovery.
+     */
     isContextMenu() {
         return true;
     }
+    /**
+     * Executes the context menu discovery.
+     * @param interaction The interaction to execute.
+     */
     execute(interaction) {
         return super.execute([interaction]);
     }
+    /**
+     * Converts the context menu discovery to JSON.
+     */
     toJSON() {
         return this.meta;
     }

package/dist/commands/context-menus/context-menus.service.d.ts

@@ -1,5 +1,13 @@
 import { Collection } from 'discord.js';
 import { ContextMenuDiscovery, ContextMenuMeta } from './context-menu.discovery';
+/**
+ * Service that manages context menus.
+ * @see ContextMenuDiscovery
+ * @see ContextMenuMeta
+ * @see ContextMenu
+ * @see MessageCommand
+ * @see UserCommand
+ */
 export declare class ContextMenusService {
     private readonly logger;
     readonly cache: Collection<string, ContextMenuDiscovery>;

package/dist/commands/context-menus/context-menus.service.js

@@ -10,6 +10,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContextMenusService = void 0;
 const discord_js_1 = require("discord.js");
 const common_1 = require("@nestjs/common");
+/**
+ * Service that manages context menus.
+ * @see ContextMenuDiscovery
+ * @see ContextMenuMeta
+ * @see ContextMenu
+ * @see MessageCommand
+ * @see UserCommand
+ */
 let ContextMenusService = ContextMenusService_1 = class ContextMenusService {
     constructor() {
         this.logger = new common_1.Logger(ContextMenusService_1.name);

package/dist/commands/context-menus/decorators/context-menu.decorator.d.ts

@@ -1,2 +1,12 @@
 import { ContextMenuDiscovery, ContextMenuMeta } from '../context-menu.discovery';
+/**
+ * Decorator that marks a method as a context menu.
+ * @param options The context menu options.
+ * @returns The decorated method.
+ * @see ContextMenuDiscovery
+ * @see ContextMenuMeta
+ * @see MessageCommand
+ * @see UserCommand
+ * @url https://necord.org/interactions/context-menus
+ */
 export declare const ContextMenu: import("@nestjs/core").ReflectableDecorator<ContextMenuMeta, ContextMenuDiscovery>;

package/dist/commands/context-menus/decorators/context-menu.decorator.js

@@ -3,6 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContextMenu = void 0;
 const context_menu_discovery_1 = require("../context-menu.discovery");
 const core_1 = require("@nestjs/core");
+/**
+ * Decorator that marks a method as a context menu.
+ * @param options The context menu options.
+ * @returns The decorated method.
+ * @see ContextMenuDiscovery
+ * @see ContextMenuMeta
+ * @see MessageCommand
+ * @see UserCommand
+ * @url https://necord.org/interactions/context-menus
+ */
 exports.ContextMenu = core_1.Reflector.createDecorator({
     transform: options => new context_menu_discovery_1.ContextMenuDiscovery(options)
 });

package/dist/commands/context-menus/decorators/message-command.decorator.d.ts

@@ -1,2 +1,18 @@
 import { ContextMenuMeta } from '../context-menu.discovery';
+/**
+ * Decorator that marks a method as a message context menu.
+ * @param options The context menu options.
+ * @returns The decorated method.
+ * @see ContextMenu
+ * @see ContextMenuMeta
+ * @see TargetMessage
+ * @url https://necord.org/interactions/context-menus#message-commands
+ * @example
+ * ```ts
+ * @MessageCommand({ name: 'quote', type: 'MESSAGE' })
+ * public async quote(@TargetMessage() message: Message) {
+ *     message.reply('Quoting...');
+ * }
+ * ```
+ */
 export declare const MessageCommand: (options: Omit<ContextMenuMeta, 'type'>) => import("@nestjs/common").CustomDecorator;

package/dist/commands/context-menus/decorators/message-command.decorator.js

@@ -3,5 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageCommand = void 0;
 const discord_js_1 = require("discord.js");
 const context_menu_decorator_1 = require("./context-menu.decorator");
+/**
+ * Decorator that marks a method as a message context menu.
+ * @param options The context menu options.
+ * @returns The decorated method.
+ * @see ContextMenu
+ * @see ContextMenuMeta
+ * @see TargetMessage
+ * @url https://necord.org/interactions/context-menus#message-commands
+ * @example
+ * ```ts
+ * @MessageCommand({ name: 'quote', type: 'MESSAGE' })
+ * public async quote(@TargetMessage() message: Message) {
+ *     message.reply('Quoting...');
+ * }
+ * ```
+ */
 const MessageCommand = (options) => (0, context_menu_decorator_1.ContextMenu)(Object.assign({ type: discord_js_1.ApplicationCommandType.Message }, options));
 exports.MessageCommand = MessageCommand;

package/dist/commands/context-menus/decorators/target.decorator.d.ts

@@ -2,6 +2,48 @@
  * @deprecated Use `@TargetMessage`, `@TargetUser` or `@TargetMember` instead
  */
 export declare const Target: (...dataOrPipes: any[]) => ParameterDecorator;
+/**
+ * Decorator that injects the target message of a message context menu command.
+ * @see TargetUser
+ * @see TargetMember
+ * @see MessageCommand
+ * @returns The target message.
+ * @example
+ * ```ts
+ * @MessageCommand({ name: 'quote', type: 'MESSAGE' })
+ * public async quote(@TargetMessage() message: Message) {
+ * 	message.reply('Quoting...');
+ * }
+ * ```
+ */
 export declare const TargetMessage: (...dataOrPipes: any[]) => ParameterDecorator;
+/**
+ * Decorator that injects the target user of a user context menu command.
+ * @see TargetMessage
+ * @see TargetMember
+ * @see UserCommand
+ * @returns The target user.
+ * @example
+ * ```ts
+ * @UserCommand({ name: 'kick', type: 'USER' })
+ * public async avatar(@TargetUser() user: User) {
+ *  user.avatarURL();
+ * }
+ * ```
+ */
 export declare const TargetUser: (...dataOrPipes: any[]) => ParameterDecorator;
+/**
+ * Decorator that injects the target member of a user context menu command.
+ * @see TargetMessage
+ * @see TargetUser
+ * @see UserCommand
+ * @returns The target member.
+ * @example
+ * ```ts
+ * @UserCommand({ name: 'ban', type: 'USER' })
+ * public async ban(@TargetMember() member: GuildMember) {
+ *    member.ban();
+ * }
+ * ```
+ */
 export declare const TargetMember: (...dataOrPipes: any[]) => ParameterDecorator;

package/dist/commands/context-menus/decorators/target.decorator.js

@@ -15,6 +15,20 @@ exports.Target = (0, common_1.createParamDecorator)((_, context) => {
         ? interaction.options.getMessage('message')
         : interaction.options.getUser('user');
 });
+/**
+ * Decorator that injects the target message of a message context menu command.
+ * @see TargetUser
+ * @see TargetMember
+ * @see MessageCommand
+ * @returns The target message.
+ * @example
+ * ```ts
+ * @MessageCommand({ name: 'quote', type: 'MESSAGE' })
+ * public async quote(@TargetMessage() message: Message) {
+ * 	message.reply('Quoting...');
+ * }
+ * ```
+ */
 exports.TargetMessage = (0, common_1.createParamDecorator)((_, context) => {
     const necordContext = context_1.NecordExecutionContext.create(context);
     const [interaction] = necordContext.getContext();
@@ -22,6 +36,20 @@ exports.TargetMessage = (0, common_1.createParamDecorator)((_, context) => {
         return null;
     return interaction.targetMessage;
 });
+/**
+ * Decorator that injects the target user of a user context menu command.
+ * @see TargetMessage
+ * @see TargetMember
+ * @see UserCommand
+ * @returns The target user.
+ * @example
+ * ```ts
+ * @UserCommand({ name: 'kick', type: 'USER' })
+ * public async avatar(@TargetUser() user: User) {
+ *  user.avatarURL();
+ * }
+ * ```
+ */
 exports.TargetUser = (0, common_1.createParamDecorator)((_, context) => {
     const necordContext = context_1.NecordExecutionContext.create(context);
     const [interaction] = necordContext.getContext();
@@ -29,6 +57,20 @@ exports.TargetUser = (0, common_1.createParamDecorator)((_, context) => {
         return null;
     return interaction.targetUser;
 });
+/**
+ * Decorator that injects the target member of a user context menu command.
+ * @see TargetMessage
+ * @see TargetUser
+ * @see UserCommand
+ * @returns The target member.
+ * @example
+ * ```ts
+ * @UserCommand({ name: 'ban', type: 'USER' })
+ * public async ban(@TargetMember() member: GuildMember) {
+ *    member.ban();
+ * }
+ * ```
+ */
 exports.TargetMember = (0, common_1.createParamDecorator)((_, context) => {
     const necordContext = context_1.NecordExecutionContext.create(context);
     const [interaction] = necordContext.getContext();

package/dist/commands/context-menus/decorators/user-command.decorator.d.ts

@@ -1,2 +1,19 @@
 import { ContextMenuMeta } from '../context-menu.discovery';
+/**
+ * Decorator that marks a method as a user context menu.
+ * @param options The context menu options.
+ * @returns The decorated method.
+ * @see ContextMenu
+ * @see ContextMenuMeta
+ * @see TargetUser
+ * @see TargetMessage
+ * @url https://necord.org/interactions/context-menus#user-commands
+ * @example
+ * ```ts
+ * @UserCommand({ name: 'ping' })
+ * public async ping(@TargetUser() user: User) {
+ *     user.send('Pong!');
+ * }
+ * ```
+ */
 export declare const UserCommand: (options: Omit<ContextMenuMeta, 'type'>) => import("@nestjs/common").CustomDecorator;

package/dist/commands/context-menus/decorators/user-command.decorator.js

@@ -3,5 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserCommand = void 0;
 const discord_js_1 = require("discord.js");
 const context_menu_decorator_1 = require("./context-menu.decorator");
+/**
+ * Decorator that marks a method as a user context menu.
+ * @param options The context menu options.
+ * @returns The decorated method.
+ * @see ContextMenu
+ * @see ContextMenuMeta
+ * @see TargetUser
+ * @see TargetMessage
+ * @url https://necord.org/interactions/context-menus#user-commands
+ * @example
+ * ```ts
+ * @UserCommand({ name: 'ping' })
+ * public async ping(@TargetUser() user: User) {
+ *     user.send('Pong!');
+ * }
+ * ```
+ */
 const UserCommand = (options) => (0, context_menu_decorator_1.ContextMenu)(Object.assign({ type: discord_js_1.ApplicationCommandType.User }, options));
 exports.UserCommand = UserCommand;

package/dist/commands/slash-commands/autocomplete/autocomplete.interceptor.d.ts

@@ -1,6 +1,12 @@
 import { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
 import { Observable } from 'rxjs';
 import { AutocompleteInteraction } from 'discord.js';
+/**
+ * The autocomplete interceptor.
+ * @see AutocompleteContext
+ * @see AutocompleteInteraction
+ * @url https://necord.org/interactions/slash-commands#autocomplete
+ */
 export declare abstract class AutocompleteInterceptor implements NestInterceptor {
     abstract transformOptions(interaction: AutocompleteInteraction): void | Promise<void>;
     intercept(context: ExecutionContext, next: CallHandler): Promise<Observable<any>>;

package/dist/commands/slash-commands/autocomplete/autocomplete.interceptor.js

@@ -19,6 +19,12 @@ exports.AutocompleteInterceptor = void 0;
 const common_1 = require("@nestjs/common");
 const rxjs_1 = require("rxjs");
 const context_1 = require("../../../context");
+/**
+ * The autocomplete interceptor.
+ * @see AutocompleteContext
+ * @see AutocompleteInteraction
+ * @url https://necord.org/interactions/slash-commands#autocomplete
+ */
 let AutocompleteInterceptor = class AutocompleteInterceptor {
     intercept(context, next) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/commands/slash-commands/decorators/slash-command.decorator.d.ts

@@ -1,2 +1,11 @@
 import { SlashCommandDiscovery, SlashCommandMeta } from '../slash-command.discovery';
+/**
+ * Decorator that marks a method as a slash command.
+ * @param options The slash command options.
+ * @returns The decorated method.
+ * @see SlashCommandDiscovery
+ * @see SlashCommandMeta
+ * @url https://necord.org/interactions/slash-commands
+ *
+ */
 export declare const SlashCommand: import("@nestjs/core").ReflectableDecorator<Omit<SlashCommandMeta, "type" | "options">, SlashCommandDiscovery>;

package/dist/commands/slash-commands/decorators/slash-command.decorator.js

@@ -4,6 +4,15 @@ exports.SlashCommand = void 0;
 const slash_command_discovery_1 = require("../slash-command.discovery");
 const discord_js_1 = require("discord.js");
 const core_1 = require("@nestjs/core");
+/**
+ * Decorator that marks a method as a slash command.
+ * @param options The slash command options.
+ * @returns The decorated method.
+ * @see SlashCommandDiscovery
+ * @see SlashCommandMeta
+ * @url https://necord.org/interactions/slash-commands
+ *
+ */
 exports.SlashCommand = core_1.Reflector.createDecorator({
     transform: options => new slash_command_discovery_1.SlashCommandDiscovery(Object.assign({ type: discord_js_1.ApplicationCommandType.ChatInput }, options))
 });

package/dist/commands/slash-commands/decorators/subcommand-group.decorator.d.ts

@@ -1,3 +1,18 @@
 import { SlashCommandDiscovery, SlashCommandMeta } from '../slash-command.discovery';
+/**
+ * Decorator that marks a method as a subcommand.
+ * @param options The subcommand options.
+ * @returns The decorated method.
+ * @see SlashCommandDiscovery
+ * @url https://necord.org/interactions/slash-commands#groups
+ */
 export declare const SubcommandGroup: import("@nestjs/core").ReflectableDecorator<Omit<SlashCommandMeta, "type" | "defaultMemberPermissions" | "guilds" | "options">, SlashCommandDiscovery>;
+/**
+ * Factory that creates a decorator that marks a class as a slash command group.
+ * @param rootOptions
+ * @returns The decorator.
+ * @see SlashCommand
+ * @see SubcommandGroup
+ * @url https://necord.org/interactions/slash-commands#groups
+ */
 export declare const createCommandGroupDecorator: (rootOptions: Omit<SlashCommandMeta, 'type'>) => (subOptions?: Omit<SlashCommandMeta, 'type'>) => ClassDecorator;

package/dist/commands/slash-commands/decorators/subcommand-group.decorator.js

@@ -7,9 +7,24 @@ const slash_command_discovery_1 = require("../slash-command.discovery");
 const slash_command_decorator_1 = require("./slash-command.decorator");
 const rxjs_1 = require("rxjs");
 const core_1 = require("@nestjs/core");
+/**
+ * Decorator that marks a method as a subcommand.
+ * @param options The subcommand options.
+ * @returns The decorated method.
+ * @see SlashCommandDiscovery
+ * @url https://necord.org/interactions/slash-commands#groups
+ */
 exports.SubcommandGroup = core_1.Reflector.createDecorator({
     transform: options => new slash_command_discovery_1.SlashCommandDiscovery(Object.assign({ type: discord_js_1.ApplicationCommandOptionType.SubcommandGroup }, options))
 });
+/**
+ * Factory that creates a decorator that marks a class as a slash command group.
+ * @param rootOptions
+ * @returns The decorator.
+ * @see SlashCommand
+ * @see SubcommandGroup
+ * @url https://necord.org/interactions/slash-commands#groups
+ */
 const createCommandGroupDecorator = (rootOptions) => {
     const rootCommand = (0, slash_command_decorator_1.SlashCommand)(rootOptions);
     return (subOptions) => {

package/dist/commands/slash-commands/decorators/subcommand.decorator.d.ts

@@ -1,2 +1,9 @@
 import { SlashCommandDiscovery, SlashCommandMeta } from '../slash-command.discovery';
+/**
+ * Decorator that marks a method as a subcommand.
+ * @param options The subcommand options.
+ * @returns The decorated method.
+ * @see SlashCommandDiscovery
+ * @url https://necord.org/interactions/slash-commands#groups
+ */
 export declare const Subcommand: import("@nestjs/core").ReflectableDecorator<Omit<SlashCommandMeta, "type" | "defaultMemberPermissions" | "guilds" | "options">, SlashCommandDiscovery>;

package/dist/commands/slash-commands/decorators/subcommand.decorator.js

@@ -4,6 +4,13 @@ exports.Subcommand = void 0;
 const slash_command_discovery_1 = require("../slash-command.discovery");
 const discord_js_1 = require("discord.js");
 const core_1 = require("@nestjs/core");
+/**
+ * Decorator that marks a method as a subcommand.
+ * @param options The subcommand options.
+ * @returns The decorated method.
+ * @see SlashCommandDiscovery
+ * @url https://necord.org/interactions/slash-commands#groups
+ */
 exports.Subcommand = core_1.Reflector.createDecorator({
     transform: options => new slash_command_discovery_1.SlashCommandDiscovery(Object.assign({ type: discord_js_1.ApplicationCommandOptionType.Subcommand }, options))
 });

package/dist/commands/slash-commands/options/attachment-option.decorator.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Param decorator that marks a method as an attachment option.
+ * @param options The attachment options.
+ * @returns The decorated method.
+ * @url https://necord.org/interactions/slash-commands#options
+ */
 export declare const AttachmentOption: (data: {
     name: string;
     description: string;

package/dist/commands/slash-commands/options/attachment-option.decorator.js

@@ -3,4 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AttachmentOption = void 0;
 const discord_js_1 = require("discord.js");
 const option_util_1 = require("./option.util");
+/**
+ * Param decorator that marks a method as an attachment option.
+ * @param options The attachment options.
+ * @returns The decorated method.
+ * @url https://necord.org/interactions/slash-commands#options
+ */
 exports.AttachmentOption = (0, option_util_1.createOptionDecorator)(discord_js_1.ApplicationCommandOptionType.Attachment, 'getAttachment');

package/dist/commands/slash-commands/options/boolean-option.decorator.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Param decorator that marks a method as a boolean option.
+ * @param options The boolean options.
+ * @returns The decorated method.
+ * @url https://necord.org/interactions/slash-commands#options
+ */
 export declare const BooleanOption: (data: {
     name: string;
     description: string;

package/dist/commands/slash-commands/options/boolean-option.decorator.js

@@ -3,4 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BooleanOption = void 0;
 const discord_js_1 = require("discord.js");
 const option_util_1 = require("./option.util");
+/**
+ * Param decorator that marks a method as a boolean option.
+ * @param options The boolean options.
+ * @returns The decorated method.
+ * @url https://necord.org/interactions/slash-commands#options
+ */
 exports.BooleanOption = (0, option_util_1.createOptionDecorator)(discord_js_1.ApplicationCommandOptionType.Boolean, 'getBoolean');

package/dist/commands/slash-commands/options/channel-option.decorator.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Param decorator that marks a method as a channel option.
+ * @param options The channel options.
+ * @returns The decorated method.
+ * @url https://necord.org/interactions/slash-commands#options
+ */
 export declare const ChannelOption: (data: {
     name: string;
     description: string;

package/dist/commands/slash-commands/options/channel-option.decorator.js

@@ -3,4 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChannelOption = void 0;
 const discord_js_1 = require("discord.js");
 const option_util_1 = require("./option.util");
+/**
+ * Param decorator that marks a method as a channel option.
+ * @param options The channel options.
+ * @returns The decorated method.
+ * @url https://necord.org/interactions/slash-commands#options
+ */
 exports.ChannelOption = (0, option_util_1.createOptionDecorator)(discord_js_1.ApplicationCommandOptionType.Channel, 'getChannel');

package/dist/commands/slash-commands/options/integer-option.decorator.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Param decorator that marks a method as an integer option.
+ * @param options The integer options.
+ * @returns The decorated method.
+ * @url https://necord.org/interactions/slash-commands#options
+ */
 export declare const IntegerOption: (data: {
     name: string;
     description: string;