Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ParserOptions

Options describing the command syntax for the Parser.

Hierarchy

  • ParserOptions

Index

Properties

Optional emptyArgMarkers

emptyArgMarkers: Lexeme[]

Empty argument markers used to mark argument with undefined value.

Optional escapeMarkers

escapeMarkers: Lexeme[]

Escape markers used to escape closing quotes in quoted arguments. Also can be used to escape themselves.

Optional flagMarkers

flagMarkers: Lexeme[]

Flag markers mark the beginning of the command flag.

Optional flagValueMarkers

flagValueMarkers: Lexeme[]

Flag value markers separate the flag value from the flag name. E.g in "--flag = value" the equal sign is the flag value marker.

Optional quotes

quotes: Array<Lexeme | [Lexeme, Lexeme]>

Quoted argument markers. A quote may be single ( " ) or paired ( {, } ).

Optional restMarkers

restMarkers: Lexeme[]

When the parser reaches a rest marker, it parses the rest of the source as a string argument.

Optional separators

separators: Lexeme[]

Argument separators. A separator may be a single character or a string.

Generated using TypeDoc