npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

minim-parse-result

v0.11.1

Published

Minim Parse Result Namespace

Downloads

3,776

Readme

Minim Parse Result Namespace

NPM version License

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);