Class ParjserBase<TValue>`Abstract`

The internal base Parjs parser class, which supports only basic parsing operations. Should not be used in user code.

Type Parameters

TValue

Implements

Parjser<TValue>

Index

Constructors

Properties

debugFunction? expecting

Methods

_apply apply debug expects pipe

action

informational

Constructors

constructor

new ParjserBase<TValue>(): ParjserBase<TValue>
Type Parameters
- TValue
Returns ParjserBase<TValue>

Properties

`Private` `Optional` debugFunction

debugFunction?: ParjserDebugFunction

`Abstract` expecting

expecting: string

Methods

`Protected` `Abstract` _apply

_apply(ps): void
The internal operation performed by the PARSER. This will be overriden by derived classes.
Parameters
- ps: ParsingState
Returns void
- Defined in src/lib/internal/parser.ts:148

apply

apply(ps): void
Apply the parser to the given state.
Parameters
- ps: ParsingState
  The parsing state.
Returns void
Implementation of Parjser.apply
- Defined in src/lib/internal/parser.ts:104

debug

debug(fn?): Parjser<TValue>
Returns this parser unchanged, but logs the result of the parse to the console. This is useful for debugging.
Parameters
- fn: ParjserDebugFunction = defaultDebugFunction
Returns Parjser<TValue>
Implementation of Parjser.debug
- Defined in src/lib/internal/parser.ts:93

expects

expects(expecting): Parjser<TValue>
Returns a copy of this, but with the given default error message.
Parameters
- expecting: string
  Description of the input.
Returns Parjser<TValue>
Implementation of Parjser.expects
- Defined in src/lib/internal/parser.ts:87

pipe

pipe<T, T1, T2, T3, T4, T5, T6>(cmb1?, cmb2?, cmb3?, cmb4?, cmb5?, cmb6?): Parjser<T6>
The chaining or piping operator. Applies a sequence of combinators to this parser, feeding the result of one into the input of the next.
Type Parameters
- T
- T1
- T2 = T1
- T3 = T2
- T4 = T3
- T5 = T4
- T6 = T5
Parameters
- Optional cmb1: ParjsCombinator<T, T1>
  The single combinator to apply.
- Optional cmb2: ParjsCombinator<T1, T2>
- Optional cmb3: ParjsCombinator<T2, T3>
- Optional cmb4: ParjsCombinator<T3, T4>
- Optional cmb5: ParjsCombinator<T4, T5>
- Optional cmb6: ParjsCombinator<T5, T6>
Returns Parjser<T6>
Implementation of Parjser.pipe
- Defined in src/lib/internal/parser.ts:192

action

parse

parse(input, initialState?): ParjsResult<TValue>
Applies this on the given input string.
Parameters
- input: string
  The input string.
- Optional initialState: UserState
  An object containing properties that are merged with this parse invocation's user state.
Returns ParjsResult<TValue>
Implementation of Parjser.parse
- Defined in src/lib/internal/parser.ts:150

informational

`Abstract` type

type: string

Exposes the display name of the parser. Userful when debugging.