Class FlagBoolean

A flag of type boolean

Hierarchy

FlagBase<boolean>
- FlagBoolean

Index

Constructors

Properties

Accessors

default name short usage value values

Methods

add defaultString isBool isValid reset valuesString

Constructors

constructor

new FlagBoolean(opts: FlagOptionsLike<boolean>): FlagBoolean
Parameters
- opts: FlagOptionsLike<boolean>
Returns FlagBoolean
Overrides FlagBase.constructor
- Defined in src/mod.ts:1114

Properties

`Readonly` opts

opts: FlagOptions<boolean>

`Protected` value_

value_: boolean

Accessors

default

get default(): T
Returns T
Inherited from FlagBase.default
- Defined in src/mod.ts:844

name

get name(): string
Returns string
Inherited from FlagBase.name
- Defined in src/mod.ts:841

short

get short(): string
Returns string
Inherited from FlagBase.short
- Defined in src/mod.ts:838

usage

get usage(): string
Returns string
Inherited from FlagBase.usage
- Defined in src/mod.ts:847

value

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

Returns T
Inherited from FlagBase.value
- Defined in src/mod.ts:807

values

get values(): undefined | T[]
Returns undefined | T[]
Inherited from FlagBase.values
- Defined in src/mod.ts:850

Methods

add

add(v?: string): boolean
Parameters
- Optional v: string
Returns boolean
Overrides FlagBase.add
- Defined in src/mod.ts:1126

defaultString

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

Returns string
Inherited from FlagBase.defaultString
- Defined in src/mod.ts:912

isBool

isBool(): boolean
Returns boolean
Overrides FlagBase.isBool
- Defined in src/mod.ts:1120

isValid

isValid(v: boolean): boolean
Parameters
- v: boolean
Returns boolean
Inherited from FlagBase.isValid
- Defined in src/mod.ts:853

reset

reset(): void
set value to default value

Returns void
Inherited from FlagBase.reset
- Defined in src/mod.ts:900

valuesString

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

Returns string
Inherited from FlagBase.valuesString
- Defined in src/mod.ts:937

Generated using TypeDoc