Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Argument

Command Argument

Hierarchy

  • Argument

Index

Constructors

constructor

Properties

Private _aliases

_aliases: Array<string> = []

Private Optional _label

_label: undefined | string

Private _type

_type: ArgumentType = CommandArgumentTypes.STRING

default

default: ArgumentDefault = undefined

Optional metadata

metadata: undefined | object

name

name: string

prefixes

prefixes: Set<string> = new Set(['-'])

Accessors

aliases

  • get aliases(): Array<string>
  • set aliases(value: Array<string>): void
  • Returns Array<string>

  • Parameters

    • value: Array<string>

    Returns void

label

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

  • Parameters

    • value: string

    Returns void

names

  • get names(): Array<string>
  • Returns Array<string>

type

  • Returns ArgumentType

  • Parameters

    Returns void

Methods

check

  • check(name: string): boolean
  • Parameters

    • name: string

    Returns boolean

getInfo

  • getInfo(content: string): object
  • Parameters

    • content: string

    Returns object

    • index: number
    • name: string

getName

  • getName(content: string): null | string
  • Parameters

    • content: string

    Returns null | string

parse

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

    Returns Promise<any>

Generated using TypeDoc