Class CCliStringArgGroup<Optional>

string-valued argument group

Type parameters

Optional: boolean

Hierarchy

CCliArgGroup<CCliStringArgGroupValue<Optional>, Optional>
- CCliStringArgGroup

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

Protected constructor

new CCliStringArgGroup(options: CCliArgGroupOptions<Optional>): CCliStringArgGroup

Inherited from CCliFlagArgGroup.constructor
- Defined in src/c-cli-arg-group.ts:49
Parameters
- options: CCliArgGroupOptions<Optional>
Returns CCliStringArgGroup

Properties

_optional

_optional: Optional = this.options.optional as Optional

Protected options

options: CCliArgGroupOptions<Optional>

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[], _search?: undefined | string): string[]

Inherited from CCliFlagArgGroup._suggest
- Defined in src/c-cli-arg-group.ts:79
Experimental support for autocompletion. Optionally implemented by subclass.

Parameters
- _args: string[]
- Optional _search: undefined | string
Returns string[]

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>): CCliStringArgGroupValue<Optional>

Overrides CCliArgGroup.parse
- Defined in src/arg-groups/c-cli-string-arg-group.ts:20
Parameters
- args: CCliParseArgs<Optional>
Returns CCliStringArgGroupValue<Optional>

undefinedAsValue

undefinedAsValue(): CCliStringArgGroupValue<Optional>

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

Static create

create<Optional>(options?: CCliStringArgGroupOptions<Optional>): CCliStringArgGroup<Optional>

- Defined in src/arg-groups/c-cli-string-arg-group.ts:31
CCliStringArgGroup factory function

Type parameters
- Optional: boolean
Parameters
- Default value options: CCliStringArgGroupOptions<Optional> = {}
Returns CCliStringArgGroup<Optional>

Generated using TypeDoc and MonoLisa