Class FlagBase<T>

A base class provides some common methods for the class flag

Type Parameters

T

Hierarchy

FlagBase

Implements

FlagDefine<T>

Index

Constructors

Properties

Accessors

default name short usage value values

Methods

_equal add defaultString isBool isValid reset valuesString

Constructors

constructor

new FlagBase<T>(opts: FlagOptions<T>): FlagBase<T>
Type Parameters
- T
Parameters
- opts: FlagOptions<T>
Returns FlagBase<T>
- Defined in src/mod.ts:810

Properties

`Readonly` opts

opts: FlagOptions<T>

`Protected` value_

value_: T

Accessors

default

get default(): T
Returns T
Implementation of FlagDefine.default
- Defined in src/mod.ts:844

name

get name(): string
Returns string
Implementation of FlagDefine.name
- Defined in src/mod.ts:841

short

get short(): string
Returns string
Implementation of FlagDefine.short
- Defined in src/mod.ts:838

usage

get usage(): string
Returns string
Implementation of FlagDefine.usage
- Defined in src/mod.ts:847

value

get value(): T
The value parsed by this flag

Returns T
Implementation of FlagDefine.value
- Defined in src/mod.ts:807

values

get values(): undefined | T[]
Returns undefined | T[]
Implementation of FlagDefine.values
- Defined in src/mod.ts:850

Methods

`Private` _equal

_equal(l: T, r: T): boolean
Parameters
- l: T
- r: T
Returns boolean
- Defined in src/mod.ts:887

add

add(_?: string): boolean
Parsed to this flag
Parameters
- Optional _: string
  
  The parsed command line value
Returns boolean
Implementation of FlagDefine.add
- Defined in src/mod.ts:944

defaultString

defaultString(): string
Returns a string description of the default value

Returns string
Implementation of FlagDefine.defaultString
- Defined in src/mod.ts:912

isBool

isBool(): boolean
Returns whether it is a bool flag

Returns boolean
Implementation of FlagDefine.isBool
- Defined in src/mod.ts:947

isValid

isValid(v: T): boolean
Parameters
- v: T
Returns boolean
Implementation of FlagDefine.isValid
- Defined in src/mod.ts:853

reset

reset(): void
set value to default value

Returns void
Implementation of FlagDefine.reset
- Defined in src/mod.ts:900

valuesString

valuesString(): string
Returns a string description of the list of valid values

Returns string
Implementation of FlagDefine.valuesString
- Defined in src/mod.ts:937

Generated using TypeDoc