Class Parser

Class for parsing commands.

Hierarchy

Parser

Index

Constructors

constructor

Properties

Accessors

mode

Methods

Constructors

constructor

new Parser(source: string, options: ParserOptions): Parser
new Parser(source: InputStream, options: ParserOptions): Parser

- Defined in src/Parser.ts:34
Parameters
- source: string
  
  The source string.
- options: ParserOptions
  
  The parser options.
Returns Parser
- Defined in src/Parser.ts:40
Parameters
- source: InputStream
  
  The source string.
- options: ParserOptions
  
  The parser options.
Returns Parser

Properties

Private modeStack

modeStack: unknown[] = []

The parsing mode stack.

options

options: ParserOptions

The parser options.

source

source: InputStream

The source input stream.

Accessors

Private mode

get mode(): unknown

- Defined in src/Parser.ts:56
The current parsing mode.

Returns unknown

Methods

argument

argument(): CommandArgument | null

- Defined in src/Parser.ts:158
Tries to parse a command argument.

Returns CommandArgument | null

command

command(): Command | null

- Defined in src/Parser.ts:81
Tries to parse a command.

Returns Command | null

commandPart

commandPart(): CommandPart | null

- Defined in src/Parser.ts:116
Tries to parse a command part.

Returns CommandPart | null

commandParts

commandParts(count?: undefined | number): CommandPart[]

- Defined in src/Parser.ts:99
Parses command parts while the source is valid and the desired part count is not reached (if set).

Parameters
- Optional count: undefined | number
  
  Number of parts to parse.
Returns CommandPart[]

Private findPresentingOpeningQuote

findPresentingOpeningQuote(): Lexeme | undefined

- Defined in src/Parser.ts:293
Returns the opening quote presented at the current source position, if any.

Returns Lexeme | undefined

flag

flag(): CommandFlag | null

- Defined in src/Parser.ts:125
Tries to parse a command flag.

Returns CommandFlag | null

Private getClosingQuote

getClosingQuote(opening: Lexeme): string

- Defined in src/Parser.ts:278
Returns the corresponding closing quote for the opening one.

Parameters
- opening: Lexeme
  
  The opening quote.
Returns string

matchRest

matchRest(): StringArgument

- Defined in src/Parser.ts:70
Matches the rest of the source and returns it as a string.

Returns StringArgument

quoted

quoted(): StringArgument | null

- Defined in src/Parser.ts:187
Tries to parse a quoted string argument.

Returns StringArgument | null

reset

reset(): void

- Defined in src/Parser.ts:63
Resets the parser state.

Returns void

rest

rest(): StringArgument | null

- Defined in src/Parser.ts:167
Tries to match a rest marker. If matched, matches and returns the rest of the source as a string argument. Otherwise, returns null.

Returns StringArgument | null

simple

simple(): StringArgument | null

- Defined in src/Parser.ts:249
Tries to parse a simple string argument (anything which is not a marker).

Returns StringArgument | null

simpleOrEmpty

simpleOrEmpty(): CommandArgument | null

- Defined in src/Parser.ts:238
Tries to parse a simple or an empty argument.

Returns CommandArgument | null

skipSeparators

skipSeparators(): void

- Defined in src/Parser.ts:304
Skips all subsequent separators.

Returns void

string

string(): StringArgument | null

- Defined in src/Parser.ts:180
Tries to parse a string argument.

Returns StringArgument | null

Generated using TypeDoc