Interface MatchResult

Result of Grammar#match

interface MatchResult {
    message?: string;
    shortMessage?: string;
    failed(): boolean;
    getInterval(): Interval;
    succeeded(): boolean;
}

Properties

message? shortMessage?

Methods

failed getInterval succeeded

Properties

Optional message

message?: string

If match failed contains an error message indicating where and why the match failed. This message is suitable for end users of a language (i.e., people who do not have access to the grammar source).

Optional shortMessage

shortMessage?: string

If match failed contains an abbreviated version of this.message that does not include an excerpt from the invalid input.

Methods

failed

  • failed(): boolean

  • True iff match did not succeed

    Returns boolean

getInterval

  • getInterval(): Interval

  • If this MatchResult is a failure, returns an Interval indicating the position of the rightmost failure.

    Returns Interval

succeeded

  • succeeded(): boolean

  • True iff match succeeded

    Returns boolean

Settings

Member Visibility

Theme

On This Page

messageshortMessagefailedgetIntervalsucceeded

Generated using TypeDoc