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

@nickmanning214/walk-tree

v0.5.5

Published

A general solution for walking trees of any structure

Downloads

49

Readme

This package provides a Tree class. The tree class converts a generic tree structure to a flat list of "Nodes". Each node has a path (represented as an array), and a value.

With instances of the tree, you can update the tree with an API (create, edit, delete nodes).

In order to set this all up, you need to configure:

  1. Tree instance setup
    1. Describe roots (describeRoots)
      • return an array of values that indicate the roots of the tree. It will internally convert this to an array of nodes.
    2. Describe children (describeChildren)
      • return an array of children in terms of the "parent" argument
  2. Tree instance manipulation
    1. Describe add (describeAdd)
      • manually update the structure in terms of the added Node instance. It has been added to the Tree instance internally but not the structure yet.
        • Note: it's worth questioning what the passed props should be. You can pass the structure but in theory it should be available in the parent scope, or in node.tree.structure.
    2. Describe edit
      • manually edit the structure in terms of the edited Node instance.
    3. Describe remove
      • manually remove a node from the structure in terms of the deleted Node instance.

What needs to be tested:

  1. Can a tree create a list of nodes based on describe roots and describe children.
  2. Can a tree update the list of nodes based on create, edit, and delete.

So the tests should be:

  1. #constructor (test the nodes array)
  2. addChildNode, editNode, removeNode (test the nodes array and test the structure)

TODO: Rather than defining each action explicitly, there could be another class that simply rebuilds the entire tree from scratch. You would need a cleanup function to start, then simply another version of describeRoots and describeChildren. Problem is that this might not be that performant. It makes more sense to just define actions to the original structure.