Global

Type Definitions

formatSettings

Settings for a Format object

Type:
  • Object
Properties:
Name Type Attributes Description
separators object <optional>

An object with start and end properties:

Properties
Name Type Description
start string

string that will indicate the start of a nonterminal.
end string

string that will indicate the end of a nonterminal.
inlineOptionals object <optional>

An object with start, end, and probability properties:

Properties
Name Type Description
start string

string that will indicate the start of an inlineOptional.
end string

string that will indicate the end of an inlineOptional.
probability string

the probability of text within an inlineOptional being included in string returned by this Format's expand method
Source: