Interface CommandModule<TData, TOptions, TReturn>

A command module that can be executed by the CLI engine.

interface CommandModule<
    TData = unknown,
    TOptions extends OptionsConfig = OptionsConfig,
    TReturn = unknown,
> {
    description?: string;
    handler: CommandHandler<TData, TOptions, TReturn>;
    isMiddleware?: boolean;
    options?: TOptions;
    requiresSubcommand?: boolean;
}

Type Parameters

  • TData = unknown

    The data type the handler expects to receive.

  • TOptions extends OptionsConfig = OptionsConfig

    The OptionsConfig type for the command.

  • TReturn = unknown

    The return type of the command handler.

Properties

description? handler isMiddleware? options? requiresSubcommand?

Properties

Optionaldescription

description?: string

A description of the command that will be displayed in the help menu.

handler

handler: CommandHandler<TData, TOptions, TReturn>

The command handler. This is where the command's logic is executed.

OptionalisMiddleware

isMiddleware?: boolean

If true, the command will be executed before the next command in the chain.

Default

true

Optionaloptions

options?: TOptions

The options config for the command.

OptionalrequiresSubcommand

requiresSubcommand?: boolean

If true, the command will require a subcommand to be executed.

Default

false

Settings

Member Visibility

On This Page

Properties