Interface Parjser<T>

Interface for parsers that produce result values of type {T}

interface Parjser<out T> {
    expecting: string;
    type: string;
    apply(ps): void;
    debug(fn?): Parjser<T>;
    expects(message): Parjser<T>;
    parse(input, initialState?): ParjsResult<T>;
    pipe<const T1>(cmb1): Parjser<T1>;
    pipe<const T1, const T2>(cmb1, cmb2): Parjser<T2>;
    pipe<const T1, const T2, const T3>(cmb1, cmb2, cmb3): Parjser<T3>;
    pipe<const T1, const T2, const T3, const T4>(cmb1, cmb2, cmb3, cmb4): Parjser<T4>;
    pipe<const T1, const T2, const T3, const T4, const T5>(cmb1, cmb2, cmb3, cmb4, cmb5): Parjser<T5>;
    pipe<const T1, const T2, const T3, const T4, const T5, const T6>(cmb1, cmb2, cmb3, cmb4, cmb5, cmb6): Parjser<T6>;
}

Type Parameters

out T

Hierarchy (view full)

Parjser
- DelayedParjser

Implemented by

ParjserBase

Index

Properties

`Readonly` expecting

expecting: string

Methods

apply

apply(ps): void
Parameters
- ps: ParsingState
Returns void
- Defined in src/lib/internal/parjser.ts:29

debug

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

expects

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

pipe

pipe<const T1>(cmb1): Parjser<T1>
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
- const T1
Parameters
- cmb1: ParjsCombinator<T, T1>
  The single combinator to apply.
Returns Parjser<T1>
- Defined in src/lib/internal/parjser.ts:55
pipe<const T1, const T2>(cmb1, cmb2): Parjser<T2>
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
- const T1
- const T2
Parameters
- cmb1: ParjsCombinator<T, T1>
  The first combinator to apply.
- cmb2: ParjsCombinator<T1, T2>
  The second combinator to apply.
Returns Parjser<T2>
- Defined in src/lib/internal/parjser.ts:64
pipe<const T1, const T2, const T3>(cmb1, cmb2, cmb3): Parjser<T3>
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
- const T1
- const T2
- const T3
Parameters
- cmb1: ParjsCombinator<T, T1>
  The first combinator to apply.
- cmb2: ParjsCombinator<T1, T2>
  The second combinator to apply.
- cmb3: ParjsCombinator<T2, T3>
  The third combinator to apply.
Returns Parjser<T3>
- Defined in src/lib/internal/parjser.ts:77
pipe<const T1, const T2, const T3, const T4>(cmb1, cmb2, cmb3, cmb4): Parjser<T4>
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
- const T1
- const T2
- const T3
- const T4
Parameters
- cmb1: ParjsCombinator<T, T1>
  The first combinator to apply.
- cmb2: ParjsCombinator<T1, T2>
  The second combinator to apply.
- cmb3: ParjsCombinator<T2, T3>
  The third combinator to apply.
- cmb4: ParjsCombinator<T3, T4>
  The fourth combinator to apply.
Returns Parjser<T4>
- Defined in src/lib/internal/parjser.ts:92
pipe<const T1, const T2, const T3, const T4, const T5>(cmb1, cmb2, cmb3, cmb4, cmb5): Parjser<T5>
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
- const T1
- const T2
- const T3
- const T4
- const T5
Parameters
- cmb1: ParjsCombinator<T, T1>
  The first combinator to apply.
- cmb2: ParjsCombinator<T1, T2>
  The second combinator to apply.
- cmb3: ParjsCombinator<T2, T3>
  The third combinator to apply.
- cmb4: ParjsCombinator<T3, T4>
  The fourth combinator to apply.
- cmb5: ParjsCombinator<T4, T5>
  The fifth combinator to apply.
Returns Parjser<T5>
- Defined in src/lib/internal/parjser.ts:109
pipe<const T1, const T2, const T3, const T4, const T5, const 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
- const T1
- const T2
- const T3
- const T4
- const T5
- const T6
Parameters
- cmb1: ParjsCombinator<T, T1>
  The first combinator to apply.
- cmb2: ParjsCombinator<T1, T2>
  The second combinator to apply.
- cmb3: ParjsCombinator<T2, T3>
  The third combinator to apply.
- cmb4: ParjsCombinator<T3, T4>
  The fourth combinator to apply.
- cmb5: ParjsCombinator<T4, T5>
  The fifth combinator to apply.
- cmb6: ParjsCombinator<T5, T6>
  The sixth combinator to apply.
Returns Parjser<T6>
- Defined in src/lib/internal/parjser.ts:128

action

parse

parse(input, initialState?): ParjsResult<T>
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<T>
- Defined in src/lib/internal/parjser.ts:47

informational

`Readonly` type

type: string

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

Interface Parjser<T>

Type Parameters

Hierarchy (view full)

Implemented by

Index

Properties

Methods

action

informational

Properties

Readonly expecting

Methods

apply

Parameters

Returns void

debug

Parameters

Returns Parjser<T>

expects

Parameters

Returns Parjser<T>

pipe

Type Parameters

Parameters

Returns Parjser<T1>

Type Parameters

Parameters

Returns Parjser<T2>

Type Parameters

Parameters

Returns Parjser<T3>

Type Parameters

Parameters

Returns Parjser<T4>

Type Parameters

Parameters

Returns Parjser<T5>

Type Parameters

Parameters

Returns Parjser<T6>

action

parse

Parameters

Returns ParjsResult<T>

informational

Readonly type

Settings

Member Visibility

Theme

On This Page

`Readonly` expecting

`Readonly` type