minim-parse-result
v0.11.1
Published
Minim Parse Result Namespace
Downloads
3,776
Readme
Minim Parse Result Namespace
This library provides an interface to the Refract Parse Result namespace.
It extends upon the base types as defined in Minim and should be used with the minim-api-description package.
Install
npm install minim-parse-result
Usage
import minim from 'minim';
import parseResult from 'minim-parse-result';
const namespace = minim.namespace()
.use(parseResult);
// Initialize elements directly
const ParseResult = namespace.getElementClass('parseResult');
let category = new ParseResult();
Elements
ParseResult (ArrayElement)
An element that holds information about the result of parsing an input.
Properties
parseResult.annotations
Get an array element of all child elements with the element name annotation
. This property is read-only.
let annotations = parseResult.annotations;
parseResult.api
Get the first child element with an element name of category
and a class name of api
. This property is read-only.
let api = parseResult.api;
parseResult.errors
Get an array element of all child elements with the element name annotation
and class name error
. This property is read-only.
let errors = parseResult.errors;
parseResult.warnings
Get an array element of all child elements with the element name annotation
and class name warning
. This property is read-only.
let warnings = parseResult.warnings;
Annotation (StringElement)
An element that annotates the input or parse result with additional information, such as warnings or errors. The content of the annotation contains the text:
console.log(`Warning: ${annotation.toValue()}`);
Properties
annotation.code
An optional warning, error, or other numerical code. This is a shortcut for accessing the element's code
attribute.
// Show the code
console.log(annotation.code.toValue());
// Set the code
annotation.code = 123;
SourceMap (Element)
An element which maps a component of the parse result to the input via a given list of file locations and lengths.
The content of the source map is an array of locations.
Convenience function
You can use a convenience property to retrieve the sourceMap from any element.
// Print [[1, 2]]
console.log(element.sourceMapValue);