Interface FlagOptions<T>

Type Parameters

  • T

Hierarchy

  • FlagOptions

Properties

default isValid? name short? usage? values?

Properties

Readonly default

default: T

Default value when no flag is specified

Optional Readonly isValid

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

Type declaration

    • (v: T): boolean

    • Optional parameter validation function

      Remarks

      If values is set at the same time, isValid will be called for verification when the values do not match, and if the values match, the value will be considered valid and will not call isValid

      Parameters

      • v: T

      Returns boolean

Readonly name

name: string

flag long name

Optional Readonly short

short?: string

Optional flag short name

Optional Readonly usage

usage?: string

Optional flag usage description

Optional Readonly values

values?: T[]

An optional list of valid values for the flag

Remarks

If isValid is set at the same time, isValid will be called for verification when the values do not match, and if the values match, the value will be considered valid and will not call isValid

Settings

Member Visibility

Theme

Generated using TypeDoc