Parser

import { Parser } from "https://raw.githubusercontent.com/wavebeem/bread-n-butter/v0.6.0/src/bread-n-butter.ts";

Represents a parsing action; typically not created directly via new.

class Parser<A> {

constructor(action: (context: Context) => ActionResult<A>);

action: (context: Context) => ActionResult<A>;

and(parserB: Parser): Parser<[A, B]>;

chain(fn: (value: A) => Parser): Parser;

desc(expected: string[]): Parser<A>;

map(fn: (value: A) => B): Parser;

next(parserB: Parser): Parser;

node<S extends string>(name: S): Parser<ParseNode<S, A>>;

or(parserB: Parser): Parser<A | B>;

parse(input: string): ParseOK<A> | ParseFail;

repeat(min?, max?): Parser<A[]>;

sepBy(

separator: Parser,

min?,

max?,

): Parser<A[]>;

skip(parserB: Parser): Parser<A>;

thru(fn: (parser: this) => B): B;

trim(beforeAndAfter: Parser): Parser<A>;

tryParse(input: string): A;

wrap<B, C>(before: Parser, after: Parser<C>): Parser<A>;

}

§Type Parameters

[src]

§Constructors

new Parser(action: (context: Context) => ActionResult<A>)

[src]

Creates a new custom parser that performs the given parsing action.

§Properties

action: (context: Context) => ActionResult<A>

[src]

The parsing action. Takes a parsing Context and returns an ActionResult representing success or failure.

§Methods

and(parserB: Parser): Parser<[A, B]>

[src]

Combines two parsers one after the other, yielding the results of both in an array.

chain(fn: (value: A) => Parser): Parser

[src]

Parse using the current parser. If it succeeds, pass the value to the callback function, which returns the next parser to use.

desc(expected: string[]): Parser<A>

[src]

Returns a parser which parses the same value, but discards other error messages, using the ones supplied instead.

map(fn: (value: A) => B): Parser

[src]

Yields the value from the parser after being called with the callback.

next(parserB: Parser): Parser

[src]

Parse both and return the value of the second

node<S extends string>(name: S): Parser<ParseNode<S, A>>

[src]

Returns a parser that adds name and start/end location metadata.

or(parserB: Parser): Parser<A | B>

[src]

Try to parse using the current parser. If that fails, parse using the second parser.

parse(input: string): ParseOK<A> | ParseFail

[src]

Returns a parse result with either the value or error information.

repeat(min?, max?): Parser<A[]>

[src]

Repeats the current parser between min and max times, yielding the results in an array.

sepBy(separator: Parser, min?, max?): Parser<A[]>

[src]

Returns a parser that parses between min and max times, separated by the separator parser supplied.

skip(parserB: Parser): Parser<A>

[src]

Parse both and return the value of the first

thru(fn: (parser: this) => B): B

[src]

Returns the callback called with the parser.

trim(beforeAndAfter: Parser): Parser<A>

[src]

Ignores content before and after the current parser, based on the supplied parser.

tryParse(input: string): A

[src]

Returns the parsed result or throws an error.

wrap<B, C>(before: Parser, after: Parser<C>): Parser<A>

[src]

Wraps the current parser with before & after parsers.