discord-bot-cli/dist/models/definition/ParsableDefinition.d.ts

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

import { ParsableTypeName, ParsableTypeOf } from "../ParsableType";
/** @category Definition */
interface Parsable<TypeNames extends ParsableTypeName | readonly ParsableTypeName[]> {
    /** Provide a description. */
    readonly description?: string;
    /** The type in which is parsed the value. */
    readonly type: TypeNames;
    /** Used to check if parsed value satisfy certain conditions. */
    readonly validator?: (value: ParsableTypeOf<TypeNames>) => boolean | string;
    /** The default value if there is no value to parse. */
    readonly defaultValue?: ParsableTypeOf<TypeNames>;
}
declare type WrapParsable<T extends ParsableTypeName> = T extends any ? Parsable<T> : never;
/** @category Definition */
export declare type ParsableDefinition = WrapParsable<ParsableTypeName> | Parsable<readonly ParsableTypeName[]>;
export {};