Class PositionalOption<T>

A positional CLI option. Defined without a flag.

Type Parameters

Hierarchy

CLIOption<T>
- PositionalOption

Constructors

constructor

new PositionalOption<T>(name: string, message?: string): PositionalOption<T>
Instantiate the option.
Type Parameters
- T
Parameters
- name: string
  
  the name of the option
- message: string = ''
  
  message describing the option
Returns PositionalOption<T>
Overrides CLIOption.constructor
- Defined in src/cli/directive/options/PositionalOption.ts:13

Properties

`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.

`Readonly` message

message: string = ''

A usage message describing this parameter.

`Readonly` name

name: string

The display name of this positional argument.

Example

path, filename

`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

blacklist(...items: T[]): PositionalOption<T>
Blacklist the specified item or items and enable the blacklist.
Parameters
- Rest ...items: T[]
  
  the items to blacklist
Returns PositionalOption<T>
Inherited from CLIOption.blacklist
- Defined in src/cli/directive/options/CLIOption.ts:112

equals

equals(value: T): PositionalOption<T>
Specifies the value to be used in equality comparison and enables that comparison.
Parameters
- value: T
Returns PositionalOption<T>
Inherited from CLIOption.equals
- Defined in src/cli/directive/options/CLIOption.ts:162

getArgumentName

getArgumentName(): string
Gets the name of the option.

Returns

Returns string
Overrides CLIOption.getArgumentName
- Defined in src/cli/directive/options/PositionalOption.ts:31

getRequirementDisplays

getRequirementDisplays(): string[]
Get an array of strings denoting the human-readable requirements for this option to be valid.

Returns

Returns string[]
Inherited from CLIOption.getRequirementDisplays
- Defined in src/cli/directive/options/CLIOption.ts:226

greaterThan

greaterThan(value: T): PositionalOption<T>
Specifies the value to be used in greater-than comparison and enables that comparison.
Parameters
- value: T
Returns PositionalOption<T>
Inherited from CLIOption.greaterThan
- Defined in src/cli/directive/options/CLIOption.ts:142

greaterThanOrEqualTo

greaterThanOrEqualTo(value: T): PositionalOption<T>
Specifies the value to be used in greater-than or equal-to comparison and enables that comparison.
Parameters
- value: T
Returns PositionalOption<T>
Inherited from CLIOption.greaterThanOrEqualTo
- Defined in src/cli/directive/options/CLIOption.ts:152

lessThan

lessThan(value: T): PositionalOption<T>
Specifies the value to be used in less-than comparison and enables less-than comparison.
Parameters
- value: T
Returns PositionalOption<T>
Inherited from CLIOption.lessThan
- Defined in src/cli/directive/options/CLIOption.ts:122

lessThanOrEqualTo

lessThanOrEqualTo(value: T): PositionalOption<T>
Specifies the value to be used in less-than or equal-to comparison and enables that comparison.
Parameters
- value: T
Returns PositionalOption<T>
Inherited from CLIOption.lessThanOrEqualTo
- Defined in src/cli/directive/options/CLIOption.ts:132

optional

optional(): PositionalOption<T>
Sets the Option as optional.

Returns PositionalOption<T>
Inherited from CLIOption.optional
- Defined in src/cli/directive/options/CLIOption.ts:211

validate

validate(value: T): boolean
Checks if the specified value passes the configured comparisons.

Returns
Parameters
- value: T
Returns boolean
Inherited from CLIOption.validate
- Defined in src/cli/directive/options/CLIOption.ts:173

whitelist

whitelist(...items: T[]): PositionalOption<T>
Whitelist the specified item or items and enable the whitelist.
Parameters
- Rest ...items: T[]
  
  the items to whitelist
Returns PositionalOption<T>
Inherited from CLIOption.whitelist
- Defined in src/cli/directive/options/CLIOption.ts:102

Class PositionalOption<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

Parameters

name: string

message: string = ''

Returns PositionalOption<T>

Properties

Private blacklistItems

Optional Private equalityValue

Private greaterThanBit

Optional Private greaterThanValue

Private isOptional

Private lessThanBit

Optional Private lessThanValue

Readonly message

Readonly name

Example

Private useBlacklist

Private useEquality

Private useGreaterThan

Private useLessThan

Private useWhitelist

Private whitelistItems

Methods

blacklist

Parameters

Rest ...items: T[]

Returns PositionalOption<T>

equals

Parameters

value: T

Returns PositionalOption<T>

getArgumentName

Returns

Returns string

getRequirementDisplays

Returns

Returns string[]

greaterThan

Parameters

value: T

Returns PositionalOption<T>

greaterThanOrEqualTo

Parameters

value: T

Returns PositionalOption<T>

lessThan

Parameters

value: T

Returns PositionalOption<T>

lessThanOrEqualTo

Parameters

value: T

Returns PositionalOption<T>

optional

Returns PositionalOption<T>

validate

Returns

Parameters

value: T

Returns boolean

whitelist

Parameters

Rest ...items: T[]

Returns PositionalOption<T>

Settings

Member Visibility

Theme

`Private` blacklistItems

`Optional` `Private` equalityValue

`Private` greaterThanBit

`Optional` `Private` greaterThanValue

`Private` isOptional

`Private` lessThanBit

`Optional` `Private` lessThanValue

`Readonly` message

`Readonly` name

`Private` useBlacklist

`Private` useEquality

`Private` useGreaterThan

`Private` useLessThan

`Private` useWhitelist

`Private` whitelistItems

`Rest` ...items: T[]

`Rest` ...items: T[]