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

``sh
npm install minim-parse-result
`

Usage

`js
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

$3

##### parseResult.annotations
Get an array element of all child elements with the element name annotation. This property is read-only.

`js
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.

`js
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.

`js
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.

`js
let warnings = parseResult.warnings;
`

$3

`js
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.

`js
// Show the code
console.log(annotation.code.toValue());

// Set the code
annotation.code = 123;
`

$3

`js
// Print [[1, 2]]
console.log(element.sourceMapValue);
``