Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICliCommand<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>

An object that defines a CLI command and its arguments

Type parameters

Hierarchy

  • ICliCommandOptions<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>
    • ICliCommand

Index

Properties

Properties

action

action: (input: { ansi: ICliAnsi; console: ICliConsole; doubleDashValue: TValueFromCliArgGroup<TDoubleDashArgGroup>; namedValues: {}; positionalValue: TValueFromCliArgGroup<TPositionalArgGroup> }) => any

Function or async function that implements the command

Type declaration

    • (input: { ansi: ICliAnsi; console: ICliConsole; doubleDashValue: TValueFromCliArgGroup<TDoubleDashArgGroup>; namedValues: {}; positionalValue: TValueFromCliArgGroup<TPositionalArgGroup> }): any

    • Parameters

      • input: { ansi: ICliAnsi; console: ICliConsole; doubleDashValue: TValueFromCliArgGroup<TDoubleDashArgGroup>; namedValues: {}; positionalValue: TValueFromCliArgGroup<TPositionalArgGroup> }
        • ansi: ICliAnsi
        • console: ICliConsole
        • doubleDashValue: TValueFromCliArgGroup<TDoubleDashArgGroup>
        • namedValues: {}
        • positionalValue: TValueFromCliArgGroup<TPositionalArgGroup>

      Returns any

Optional description

description: TCliDescription

A sentence or two about this command for command-line usage

Optional doubleDashArgGroup

doubleDashArgGroup: TDoubleDashArgGroup

A ICliArgGroup for the arguments after a lone "--"

Optional hidden

hidden: undefined | false | true

If true, don't show this command in command-line usage

kind

kind: typeof CLI_COMMAND

The string literal CLI_COMMAND

name

name: string

Identifier for this command in command-line usage

Optional namedArgGroups

namedArgGroups: TNamedArgGroups

A ICliArgGroup for the arguments passed as "--name value"

Optional positionalArgGroup

positionalArgGroup: TPositionalArgGroup

A ICliArgGroup for the arguments before the first separator argument

Generated using TypeDoc and MonoLisa