Interface ICliCommandConfig

interface ICliCommandConfig {
    action: {
        binding: TBindKey | TBindKeyRef;
        method: string;
        module: Module<any>;
    } | ((container, args) => void | Promise<void>);
    arguments: ICliCommandArgumentConfig[];
    description: null | string;
    name: string;
    options: ICliCommandOptionConfig[];
}

Properties

action arguments description name options

Properties

action

action: {
    binding: TBindKey | TBindKeyRef;
    method: string;
    module: Module<any>;
} | ((container, args) => void | Promise<void>)

Command action as plain function or as ref to module service. Will be called when the command is executed.

Type declaration

  • binding: TBindKey | TBindKeyRef
  • method: string
  • module: Module<any>

Type declaration

    • (container, args): void | Promise<void>

    • Parameters

      Returns void | Promise<void>

arguments

arguments: ICliCommandArgumentConfig[]

Command arguments. Will be used in the help message.

description

description: null | string

Command description. Will be used in the help message.

name

name: string

Command name. Will be used in cli to call this command and in the help message.

options

options: ICliCommandOptionConfig[]

Command options. Will be used in the help message.

Settings

Member Visibility

Theme

On This Page

actionargumentsdescriptionnameoptions