Class: Possible

Possible

Represents a possibility in a usage Tag

new Possible(regexResults)

Parameters:
Name Type Description
regexResults Array.<string> The regex results from parsing the tag member
Since:
  • 0.2.1
Source:
lib/usage/Possible.js#L13

Properties


<nullable> max :number

The max of this possible
Type:
  • number
Since:
  • 0.2.1
Source:
lib/usage/Possible.js#L40

<nullable> min :number

The min of this possible
Type:
  • number
Since:
  • 0.2.1
Source:
lib/usage/Possible.js#L33

name :string

The name of this possible
Type:
  • string
Since:
  • 0.2.1
Source:
lib/usage/Possible.js#L19

<nullable> regex :RegExp

The regex of this possible
Type:
  • RegExp
Since:
  • 0.3.0
Source:
lib/usage/Possible.js#L47

type :string

The type of this possible
Type:
  • string
Since:
  • 0.2.1
Source:
lib/usage/Possible.js#L26

Methods


<static> resolveLimit(limit, type)

Resolves a limit
Parameters:
Name Type Description
limit string The limit to evaluate
type string The type of limit
Since:
  • 0.2.1
Source:
lib/usage/Possible.js#L59
Returns:
Type
number