discord-bot-cli/dist/models/callbacks/CommandExecutor.d.ts

An easy way to build a command-based discord bot with discord.js.

import { Message, DMChannel } from "discord.js";
import { CommandSet } from "../CommandSet";
import { CommandDefinition, CommandSettings } from "../definition/CommandDefinition";
import { ParsableTypeOf } from "../ParsableType";
import { CommandSetOptions } from "../CommandSetOptions";
import { Command } from "../Command";
/** @ignore */
declare type IsGuildOnly<S extends CommandSettings, True, False> = S["guildOnly"] extends true ? True : False;
/** @ignore */
declare type MessageExtension<S> = {
    readonly guild: IsGuildOnly<S, NonNullable<Message["guild"]>, Message["guild"]>;
    readonly member: IsGuildOnly<S, NonNullable<Message["member"]>, Message["member"]>;
    readonly channel: IsGuildOnly<S, Exclude<Message["channel"], DMChannel>, Message["channel"]>;
};
/**
 * Command's executor handler.
 * @category Handler
 */
export declare type CommandExecutor<T extends CommandDefinition = CommandDefinition, S extends CommandSettings = Record<string, unknown>> = (args: {
    readonly [name in keyof T["args"]]: ParsableTypeOf<NonNullable<T["args"]>[name]["type"]> | (NonNullable<T["args"]>[name]["optional"] extends true ? undefined extends NonNullable<T["args"]>[name]["defaultValue"] ? undefined : NonNullable<T["args"]>[name]["defaultValue"] : never);
}, flags: {
    readonly [name in keyof T["flags"]]: ParsableTypeOf<NonNullable<T["flags"]>[name]["type"]> | (undefined extends NonNullable<T["flags"]>[name]["defaultValue"] ? undefined : NonNullable<T["flags"]>[name]["defaultValue"]);
}, others: {
    readonly rest: undefined extends T["rest"] ? void : readonly ParsableTypeOf<NonNullable<T["rest"]>["type"]>[];
    readonly message: Message & MessageExtension<S>;
    readonly options: CommandSetOptions;
    readonly commandSet: CommandSet;
    readonly command: Command;
} & MessageExtension<S>) => any | Promise<any>;
export {};