Options
All
  • Public
  • Public/Protected
  • All
Menu

@carnesen/cli

Index

Type aliases

TCliArgGroupArgs

TCliArgGroupArgs<TRequired>: TRequired extends true ? string[] : string[] | undefined

Defines the type of the args passed to an ICliArgGroup

Type parameters

  • TRequired: boolean

    If true, the args parameter might be undefined

TCliDescription

TCliDescription: undefined | string | TCliDescriptionFunction

TCliDescriptionFunction

TCliDescriptionFunction: (input: ICliDescriptionFunctionInput) => string

Type declaration

TCliRoot

The root of a command tree

Variables

Const CLI_COMMAND

CLI_COMMAND: "CLI_COMMAND" = "CLI_COMMAND"

"kind" of a ICliCommand

Const CLI_COMMAND_GROUP

CLI_COMMAND_GROUP: "CLI_COMMAND_GROUP" = "CLI_COMMAND_GROUP"

"kind" of an ICliCommandGroup

Const CLI_TERSE_ERROR

CLI_TERSE_ERROR: "CLI_TERSE_ERROR" = "CLI_TERSE_ERROR"

"code" of a CliTerseError

Const CLI_USAGE_ERROR

CLI_USAGE_ERROR: "CLI_USAGE_ERROR" = "CLI_USAGE_ERROR"

"code" of a CliUsageError

Functions

Cli

CliAnsi

CliCommand

  • CliCommand<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>(options: ICliCommandOptions<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>): ICliCommand<TPositionalArgGroup, TNamedArgGroups, TDoubleDashArgGroup>

CliCommandGroup

CliFlagArgGroup

CliJsonArgGroup

CliNumberArgGroup

CliNumberArrayArgGroup

CliStringArgGroup

CliStringArrayArgGroup

CliStringChoiceArgGroup

Const CliWordMark

  • CliWordMark(__namedParameters: { ansi: ICliAnsi }): string

Generated using TypeDoc and MonoLisa