Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FlagOption<T>

Non-positional, flag-based CLI option.

Type parameters

  • T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new FlagOption<T>(longFlag?: string, shortFlag?: string, message?: string, argumentDescription?: string): FlagOption<T>

Properties

Optional Readonly argumentDescription

argumentDescription: string

Private blacklistItems

blacklistItems: T[] = []

Blacklisted values.

Optional Private equalityValue

equalityValue: T

The value to be used to check equality.

Private greaterThanBit

greaterThanBit: boolean = false

If true, the greater than will be greater than or equal to.

Optional Private greaterThanValue

greaterThanValue: T

Value to be compared in greater than.

Private isOptional

isOptional: boolean = false

Is this option optional?

Private lessThanBit

lessThanBit: boolean = false

If true, the less than will be less than or equal to.

Optional Private lessThanValue

lessThanValue: T

Value to be compared in less than.

Optional Readonly longFlag

longFlag: string

Optional Readonly message

message: string

Optional Readonly shortFlag

shortFlag: string

Private useBlacklist

useBlacklist: boolean = false

Do we use the blacklist?

Private useEquality

useEquality: boolean = false

Do we use the equality operator?

Private useGreaterThan

useGreaterThan: boolean = false

Do we use the greater-than comparison?

Private useLessThan

useLessThan: boolean = false

Do we use the less-than comparison?

Private useWhitelist

useWhitelist: boolean = false

Do we use the whitelist?

Private whitelistItems

whitelistItems: T[] = []

Whitelisted values.

Methods

blacklist

equals

getArgumentName

  • getArgumentName(): string

getRequirementDisplays

  • getRequirementDisplays(): string[]

greaterThan

greaterThanOrEqualTo

lessThan

lessThanOrEqualTo

optional

validate

  • validate(value: T): boolean

whitelist

Extollo Logo

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.