Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CCliFlagArgGroup

A boolean-valued command-line argument group. This argument group type only makes sense as a named argument. For example if a CLI has a named flag argument group "foo", here's how that CLI behaves:

$ cli           // named value "foo" is `undefined`
$ cli --foo     // named value "foo" is `true`
$ cli --foo bar // usage error

Hierarchy

  • CCliArgGroup<CCliFlagArgGroupValue, CCliFlagArgGroupOptional>
    • CCliFlagArgGroup

Index

Constructors

Protected constructor

Properties

Protected options

options: CCliArgGroupOptions<CCliFlagArgGroupOptional>

Accessors

description

  • get description(): CCliDescription

hidden

  • get hidden(): boolean

optional

  • get optional(): boolean

placeholder

  • get placeholder(): string

Methods

_suggest

  • _suggest(_args: string[], _search?: undefined | string): string[]

Protected assertOneOrMoreArgs

  • assertOneOrMoreArgs(args: unknown[]): void

Protected assertSingleArg

  • assertSingleArg(args: unknown[]): void

parse

  • parse(args: string[] | undefined): CCliConditionalValue<CCliFlagArgGroupValue, CCliFlagArgGroupOptional>

undefinedAsValue

  • undefinedAsValue(): CCliFlagArgGroupValue

Static create

Generated using TypeDoc and MonoLisa