Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CCliStringChoiceArgGroup<Optional, Choices>

Command-line argument group whose value is one of the choices provided

Type parameters

  • Optional: boolean

  • Choices: CCliAnyStringChoices

Hierarchy

  • CCliArgGroup<CCliStringChoiceArgGroupValue<Optional, Choices>, Optional>
    • CCliStringChoiceArgGroup

Index

Constructors

Protected constructor

Properties

options

options: CCliStringChoiceArgGroupOptions<Optional, Choices>

Accessors

description

  • get description(): CCliDescription

hidden

  • get hidden(): boolean

optional

  • get optional(): boolean

placeholder

  • get placeholder(): string

Methods

_suggest

  • _suggest(args: string[]): string[]

Private assertOneOfChoices

  • assertOneOfChoices(arg: string): assertsarg is Choices[number]

Protected assertOneOrMoreArgs

  • assertOneOrMoreArgs(args: unknown[]): void

Protected assertSingleArg

  • assertSingleArg(args: unknown[]): void

parse

  • parse(args: CCliParseArgs<Optional>): CCliStringChoiceArgGroupValue<Optional, Choices>

undefinedAsValue

  • undefinedAsValue(): CCliStringChoiceArgGroupValue<Optional, Choices>

Static create

Generated using TypeDoc and MonoLisa