PositionalOption

flitter-cli/options/PositionalOption~ PositionalOption

A positional CLI option. Defined without a flag.

Constructor

new PositionalOption(name, message)

Instantiate the option.

Parameters:
Name Type Description
name string

the name of the option
message string

message describing the option
Source:

Extends

Members

(private) _blacklist :Array.<*>

Blacklisted values.

Type:
  • Array.<*>
Overrides:
Source:

(private) _equality_value :*

The value to be used to check equality.

Type:
  • *
Overrides:
Source:

(private) _greater_than_bit :boolean

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

Type:
  • boolean
Overrides:
Source:

(private) _greater_than_value :*

Value to be compared in greater than.

Type:
  • *
Overrides:
Source:

(private) _less_than_bit :boolean

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

Type:
  • boolean
Overrides:
Source:

(private) _less_than_value :*

Value to be compared in less than.

Type:
  • *
Overrides:
Source:

(private) _optional :boolean

Is this option optional?

Type:
  • boolean
Overrides:
Source:

(private) _use_blacklist :boolean

Do we use the blacklist?

Type:
  • boolean
Overrides:
Source:

(private) _use_equality :boolean

Do we use the equality operator?

Type:
  • boolean
Overrides:
Source:

(private) _use_greater_than :boolean

Do we use the greater-than comparison?

Type:
  • boolean
Overrides:
Source:

(private) _use_less_than :boolean

Do we use the less-than comparison?

Type:
  • boolean
Overrides:
Source:

(private) _use_whitelist :boolean

Do we use the whitelist?

Type:
  • boolean
Overrides:
Source:

(private) _whitelist :Array.<*>

Whitelisted values.

Type:
  • Array.<*>
Overrides:
Source:

argument_name

Gets the name of the option.

Overrides:
Source:

message :string

Message describing the option.

Type:
  • string
Source:

name :string

The name of the option.

Type:
  • string
Source:

requirement_displays

Get an array of strings denoting the human-readable requirements for this option to be valid.

Overrides:
Source:

Methods

blacklist(…items)

Blacklist the specified item or items and enable the blacklist.

Parameters:
Name Type Attributes Description
items * <repeatable>

the items to blacklist
Overrides:
Source:

equals(value)

Specifies the value to be used in equality comparison and enables that comparison.

Parameters:
Name Type Description
value *
Overrides:
Source:

greater_than(value)

Specifies the value to be used in greater-than comparison and enables that comparison.

Parameters:
Name Type Description
value *
Overrides:
Source:

greater_than_equal_to(value)

Specifies the value to be used in greater-than or equal-to comparison and enables that comparison.

Parameters:
Name Type Description
value *
Overrides:
Source:

less_than(value)

Specifies the value to be used in less-than comparison and enables less-than comparison.

Parameters:
Name Type Description
value *
Overrides:
Source:

less_than_equal_to(value)

Specifies the value to be used in less-than or equal-to comparison and enables that comparison.

Parameters:
Name Type Description
value *
Overrides:
Source:

optional()

Sets the Option as optional.

Overrides:
Source:

validate(value) → {boolean}

Checks if the specified value passes the configured comparisons.

Parameters:
Name Type Description
value *
Overrides:
Source:
Returns:
Type
boolean

whitelist(…items)

Whitelist the specified item or items and enable the whitelist.

Parameters:
Name Type Attributes Description
items * <repeatable>

the items to whitelist
Overrides:
Source: