Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CCliArgGroup<Value, Optional>

A group of consecutive command-line arguments parsed together into a single well-typed value

Type parameters

Hierarchy

Index

Constructors

Protected constructor

Properties

Protected options

options: CCliArgGroupOptions<Optional>

Accessors

description

hidden

  • get hidden(): boolean

optional

  • get optional(): boolean

placeholder

  • get placeholder(): string

Methods

_suggest

  • _suggest(_args: string[], _search?: undefined | string): string[]
  • Experimental support for autocompletion. Optionally implemented by subclass.

    Parameters

    • _args: string[]
    • Optional _search: undefined | string

    Returns string[]

Protected assertOneOrMoreArgs

  • assertOneOrMoreArgs(args: unknown[]): void

Protected assertSingleArg

  • assertSingleArg(args: unknown[]): void

Abstract parse

  • parse(args: CCliParseArgs<Optional>): CCliConditionalValue<Value, Optional>

undefinedAsValue

  • undefinedAsValue(): Value

Generated using TypeDoc and MonoLisa