Browse Source

Document filename option for generated parsers

master
Futago-za Ryuu 3 years ago
parent
commit
27687615e5
2 changed files with 4 additions and 2 deletions
  1. +3
    -2
      docs/guides/using-the-parser.md
  2. +1
    -0
      packages/pegjs/typings/generated-parser.d.ts

+ 3
- 2
docs/guides/using-the-parser.md View File

@ -12,7 +12,8 @@ parser.parse("abcd"); // throws an exception
You can tweak parser behavior by passing a second parameter with an `options` object to the `parse` method. The following options are supported:
* `startRule` — name of the rule to start parsing from (depends on the rules the grammar supports as starting rules)
* `tracer` — tracer to use (only if the parser was generated with `"trace": true` option passed to the compiler)
* `filename` — the name of the source passed to the generated parser; will be used by the `location()` helper
* `startRule` — name of the rule to start parsing from (depends on the rules the grammar supports as starting rules)
* `tracer` — tracer to use (only if the parser was generated with `"trace": true` option passed to the compiler)
Parsers can also support their own custom options on the `options` object passed to them.

+ 1
- 0
packages/pegjs/typings/generated-parser.d.ts View File

@ -18,6 +18,7 @@ declare namespace generatedparser {
*/
interface SourceLocation {
filename?: string;
start: SourcePosition;
end: SourcePosition;


Loading…
Cancel
Save