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

mkast

v1.2.12

Published

Abstract syntax tree transformer

Downloads

1,316

Readme

Tree

Build Status npm version Coverage Status

Converts nodes to and from JSON

Transforms commonmark nodes to and from JSON for piping between processes.

Install

npm i mkast


Usage

Serialize commonmark nodes to line-delimited JSON:

var mkast = require('mkast')
  , ast = mkast.parse('# Title\n<? @include file.md ?>');
mkast.serialize(ast).pipe(process.stdout);

For more information see the api docs.

API

parser

parser(stream[, cb])

Parse line-delimited JSON to vanilla objects.

When a callback function is given it is added as a listener for the error and finish events on the parser stream.

Returns the parser stream.

  • stream Object input stream.
  • cb Function callback function.

deserialize

deserialize([stream][, cb])

Deserialize line-delimited JSON to commonmark nodes.

When a callback function is given it is added as a listener for the error and eof events on the deserializer stream.

The eof event can fire multiple times so the callback may be called multiple times.

Returns the deserializer stream.

  • stream Object input stream.
  • cb Function callback function.

serialize

serialize(node[, opts][, cb])

Serialize a commonmark AST node to line-delimited JSON.

When the node is of the document type it's direct descendants are detached from the document and streamed as independent lines. So that consumers of the stream will know when the document ends a node with an eof type is sent to indicate the end of file (EOF).

When injecting documents into a stream it may be desirable to disable this behaviour, to do so use:

{eof: false}

When a callback function is given it is added as a listener for the error and finish events on the serializer stream.

Returns the serializer stream.

  • node Object input AST node.
  • opts Object processing options.
  • cb Function callback function.

License

MIT


Created by mkdoc on April 2, 2016