Interface PeggyTestOptions<T>

interface PeggyTestOptions<T> {
    invalid?: string;
    invalidInput?: string;
    only?: boolean;
    options?: ParserOptions & ExtraParserOptions;
    peg$maxFailPos?: number;
    skip?: boolean;
    startRule?: string;
    validInput?: string;
    validResult?: T | (res: T) => any;
}

Type Parameters

  • T

Properties

invalid? invalidInput? only? options? peg$maxFailPos? skip? startRule? validInput? validResult?

Properties

Optionalinvalid

invalid?: string

What to append to validInput to make it invalid, so that library mode will return a prefix match.

OptionalinvalidInput

invalidInput?: string

If specified, ensure that the grammar fails on this input.

Optionalonly

only?: boolean

If any test has this set to true, only run the tests with this set to true.

Optionaloptions

options?: ParserOptions & ExtraParserOptions

Extra options to pass to parse(), overriding whatever else this library would have otherwise used.

Optionalpeg$maxFailPos

peg$maxFailPos?: number

Expected peg$maxFailPos.

Optionalskip

skip?: boolean

If true, skip this test.

OptionalstartRule

startRule?: string

Which valid start rule to use? Default: grammar default start rule.

OptionalvalidInput

validInput?: string

If specified, check this against the startRule.

OptionalvalidResult

validResult?: T | (res: T) => any

What result should startRule return for validInput? Default: validInput.

Settings

Member Visibility

On This Page

Properties