Interface FlagDefine<T>

Type Parameters

  • T

Hierarchy

  • FlagDefine

Implemented by

Properties

default isValid name short usage value values?

Methods

add defaultString isBool reset valuesString

Properties

Readonly default

default: T

isValid

isValid: ((v: T) => boolean)

Type declaration

    • (v: T): boolean

    • Parameters

      • v: T

      Returns boolean

Readonly name

name: string

Readonly short

short: string

Readonly usage

usage: string

Readonly value

value: T

The value parsed by this flag

Optional Readonly values

values?: T[]

Methods

add

  • Parsed to this flag

    Parameters

    • Optional val: string

      The parsed command line value

    Returns boolean

defaultString

  • Returns a string description of the default value

    Returns string

isBool

  • Returns whether it is a bool flag

    Returns boolean

reset

  • set value to default value

    Returns void

valuesString

  • Returns a string description of the list of valid values

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc