Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Argument

Command Argument

Hierarchy

  • Argument

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _aliases

_aliases: string[] = []

Private _label

_label: string = ''

Private _name

_name: string = ''

Private Optional _names

_names: string[]

Private _type

_type: ArgumentType = ...

Optional choices

choices: any[]

Optional consume

consume: boolean = false

default

default: any = ...

help

help: string = ''

Optional metadata

metadata: {}

Type declaration

  • [key: string]: any

Optional positionalArgs

positionalArgs: ArgumentParser

prefixes

prefixes: Set<string> = ...

required

required: boolean = false

Accessors

aliases

  • get aliases(): string[]
  • set aliases(value: string[]): void

label

  • get label(): string
  • set label(value: string): void

name

  • get name(): string
  • set name(value: string): void

names

  • get names(): string[]

type

Methods

check

  • check(name: string): boolean

getInfo

  • getInfo(content: string): { index: number; name: string }

getName

  • getName(content: string): null | string

parse

  • parse(value: string, context: Context): Promise<any>

setPrefixes

  • setPrefixes(prefixes: string[], prefixSpace?: boolean): void

Generated using TypeDoc