Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICliArgGroup<TValue, TRequired>

A group of adjacent command-line arguments

Type parameters

Hierarchy

  • ICliArgGroup

Index

Properties

Optional description

description: TCliDescription

A text description of this argument group. Paragraphs are re-wrapped when printed to the terminal so don't worry about whitespace.

Optional hidden

hidden: undefined | false | true

If true, command-line usage will not normally show this arg group

parse

parse: ((args: TCliArgGroupArgs<TRequired>) => TValue) | ((args: TCliArgGroupArgs<TRequired>) => Promise<TValue>)

Function or async function that parses a well-typed value from string arguments

placeholder

placeholder: string

A short placeholder for this argument group in command-line usage e.g. "<str>"

Optional required

required: TRequired

If true, throw a CliUsageError if no argument is provided for this group

Generated using TypeDoc and MonoLisa