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

constructor

Properties

options

Accessors

Methods

Constructors

Protected constructor

new CCliStringChoiceArgGroup(options: CCliStringChoiceArgGroupOptions<Optional, Choices>): CCliStringChoiceArgGroup

Overrides CCliFlagArgGroup.constructor
- Defined in src/arg-groups/c-cli-string-choice-arg-group.ts:42
Parameters
- options: CCliStringChoiceArgGroupOptions<Optional, Choices>
Returns CCliStringChoiceArgGroup

Properties

options

options: CCliStringChoiceArgGroupOptions<Optional, Choices>

Accessors

description

get description(): CCliDescription

Inherited from CCliFlagArgGroup.description
- Defined in src/c-cli-arg-group.ts:56
Returns CCliDescription

hidden

get hidden(): boolean

Inherited from CCliFlagArgGroup.hidden
- Defined in src/c-cli-arg-group.ts:60
Returns boolean

optional

get optional(): boolean

Inherited from CCliFlagArgGroup.optional
- Defined in src/c-cli-arg-group.ts:68
Returns boolean

placeholder

get placeholder(): string

Inherited from CCliFlagArgGroup.placeholder
- Defined in src/c-cli-arg-group.ts:64
Returns string

Methods

_suggest

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

Overrides CCliFlagArgGroup._suggest
- Defined in src/arg-groups/c-cli-string-choice-arg-group.ts:79
Parameters
- args: string[]
Returns string[]

Private assertOneOfChoices

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

- Defined in src/arg-groups/c-cli-string-choice-arg-group.ts:69
Parameters
- arg: string
Returns assertsarg is Choices[number]

Protected assertOneOrMoreArgs

assertOneOrMoreArgs(args: unknown[]): void

Inherited from CCliFlagArgGroup.assertOneOrMoreArgs
- Defined in src/c-cli-arg-group.ts:89
Parameters
- args: unknown[]
Returns void

Protected assertSingleArg

assertSingleArg(args: unknown[]): void

Inherited from CCliFlagArgGroup.assertSingleArg
- Defined in src/c-cli-arg-group.ts:83
Parameters
- args: unknown[]
Returns void

parse

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

Overrides CCliArgGroup.parse
- Defined in src/arg-groups/c-cli-string-choice-arg-group.ts:49
Parameters
- args: CCliParseArgs<Optional>
Returns CCliStringChoiceArgGroupValue<Optional, Choices>

undefinedAsValue

undefinedAsValue(): CCliStringChoiceArgGroupValue<Optional, Choices>

Inherited from CCliFlagArgGroup.undefinedAsValue
- Defined in src/c-cli-arg-group.ts:97
Returns CCliStringChoiceArgGroupValue<Optional, Choices>

Static create

create<Optional, Choices>(options: CCliStringChoiceArgGroupOptions<Optional, Choices>): CCliStringChoiceArgGroup<Optional, Choices>

- Defined in src/arg-groups/c-cli-string-choice-arg-group.ts:87
CCliStringChoiceArgGroup factory function

Type parameters
- Optional: boolean
- Choices: CCliAnyStringChoices
Parameters
- options: CCliStringChoiceArgGroupOptions<Optional, Choices>
Returns CCliStringChoiceArgGroup<Optional, Choices>

Generated using TypeDoc and MonoLisa