Create a ReportBuilder from the given options
base directory that all paths are relativized from
The type of builder that should be created. Defaults to Simple
ReportBuilder
Parse (Asynchronously)
Parse an input with the given options and return a Promise of a Report.
Promise that resolves with a parsed Report
Parse the string contents and return a Report
string containing input that should be parsed
base directory that all paths are relativized from
The type of builder that should be created
Parsed Report
Generated using TypeDoc
Abstract Parser for Streams
An extension of {@link Parser | Parser} that assumes parsing will be done for a stream. Streams supported are Browser Streams (see the Streams API) or Node Streams (see the Node Streams API).
Since streams are inherently asynchronous, the parseSync method does not make sense as a function. This class implements the parseSync method and throws an error so the subclass implementations don't have to implement it.