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

@dizmo/functions-tree2json

v1.1.14

Published

Tree to JSON mapper

Downloads

5

Readme

NPM version Build Status Coverage Status

@dizmo/functions-tree2json

Provides two functions tree2array and tree2object, where:

  • tree2array: maps a hierarchical tree recursively to an array via the get (returning the value for a node) and see (returning the sub-nodes for a node) callback functions, until the tree is completely mapped (or see returning an empty list [] for the node).

The array is a recursive description of a tree, where the value of a given node is at index 0 of the array followed optionally by other arrays, each containing the name followed by a sub-tree for any given sub-nodes. Each sub-tree is again yet another array according to the same recursive description.

  • tree2object: maps a hierarchical tree recursively to a JSON-like object via te get (returning the value for a node) and see (returning the sub-nodes for a node) callback functions, until the tree is completely mapped (or see returning an empty list [] for the node).

The object conforms to the same rules like any regular JSON or JavaScript object, with the addition that the values of nodes can be directly represented using an underscore _ for the key value.

Usage

Install

npm install @dizmo/functions-tree2json --save

Require

const { tree2array, tree2object } = require('@dizmo/functions-tree2json');

Examples

import { tree2array, tree2object } from '@dizmo/functions-tree2json';
declare const db: {
    // db should return value for given path (or root)
    get: (path: string | null) => any;
    // db should return nodes for given path (or root)
    see: (path: string | null) => string[];
};
const root_array
    = tree2array(null, db.get, db.see);
const node_array
    = tree2array('path/to/node', db.get, db.see);
const root_object
    = tree2object(null, db.get, db.see);
const node_object
    = tree2object('path/to/node', db.get, db.see);

Development

Clean

npm run clean

Build

npm run build

without linting and cleaning:

npm run -- build --no-lint --no-clean

with UMD bundling (incl. minimization):

npm run -- build --prepack

with UMD bundling (excl. minimization):

npm run -- build --prepack --no-minify

Lint

npm run lint

with auto-fixing:

npm run -- lint --fix

Test

npm run test

without linting, cleaning and (re-)building:

npm run -- test --no-lint --no-clean --no-build

Cover

npm run cover

without linting, cleaning and (re-)building:

npm run -- cover --no-lint --no-clean --no-build

Documentation

npm run docs

Publish

npm publish

initially (if public):

npm publish --access=public

Copyright

© 2020 dizmo AG, Switzerland