Interface Matcher

Matcher objects are used to incrementally match a changing input against a Grammar, e.g. in an editor or IDE.

interface Matcher {
    getInput(): string;
    match(optStartRule?): MatchResult;
    replaceInputRange(startIdx, endIdx, str): Matcher;
    setInput(str): void;
    trace(optStartRule?): Object;
}

Methods

getInput match replaceInputRange setInput trace

Methods

getInput

  • getInput(): string

  • Return the current input string.

    Returns string

match

  • match(optStartRule?): MatchResult

  • Like Grammar#match, but operates incrementally.

    Parameters

    • Optional optStartRule: string

    Returns MatchResult

replaceInputRange

  • replaceInputRange(startIdx, endIdx, str): Matcher

  • Edit the current input string, replacing the characters between startIdx and endIdx with str.

    Parameters

    • startIdx: number
    • endIdx: number
    • str: string

    Returns Matcher

setInput

  • setInput(str): void

  • Set the input string to str.

    Parameters

    • str: string

    Returns void

trace

  • trace(optStartRule?): Object

  • Like Grammar#trace, but operates incrementally.

    Parameters

    • Optional optStartRule: string

    Returns Object

Settings

Member Visibility

Theme

On This Page

getInputmatchreplaceInputRangesetInputtrace

Generated using TypeDoc