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

flat-to-tree

v1.1.0

Published

Convert flat array into tree structure

Downloads

83

Readme

Flat To Tree

Convert flat array into tree structure. O(n) time complexity.

Installation

npm i flat-to-tree

Example

import flatToTree from "flat-to-tree";

const flat = [
  {
    id: 2,
    parentId: 1,
    title: "node-1-2" // any properties
  },
  {
    id: 3,
    parentId: 2,
    title: "node-1-2-3"
  },
  {
    id: 1,
    parentId: null,
    title: "root"
  }
];

const tree = flatToTree(flat);

/*
tree: 
[
  {
    id: 1,
    parentId: null,
    title: "root",
    children: [
      {
        id: 2,
        parentId: 1,
        title: "node-1-2",
        children: [
          {
            id: 3,
            parentId: 2,
            title: "node-1-2-3",
            children: []
          }
        ]
      }
    ]
  }
];
*/

const flat2 = [
  {
    key: 2,
    pId: 1,
    name: "node-1-2" // any properties
  },
  {
    key: 3,
    pId: 2,
    name: "node-1-2-3"
  },
  {
    key: 1,
    pId: null,
    name: "root"
  }
];

const tree2 = flatToTree(flat2, {
  id: "key",
  parentId: "pId",
  children: "sub"
});

/*
tree2: 
[
  {
    key: 1,
    pId: null,
    title: "root",
    sub: [
      {
        key: 2,
        pId: 1,
        title: "node-1-2",
        sub: [
          {
            key: 3,
            pId: 2,
            title: "node-1-2-3",
            sub: []
          }
        ]
      }
    ]
  }
];
*/

const flat3 = [
  {
    id: 2,
    parentId: 1,
    title: "node-1-2"
  },
  {
    id: 1,
    parentId: 10, // not exist, will be considered as root nodes
    title: "root-1"
  },
  {
    id: 4,
    parentId: 10, // not exist, will be considered as root nodes
    title: "root-4"
  },
  {
    id: 3,
    parentId: 2,
    title: "node-1-2-3"
  }
];

const tree3 = flatToTree(flat3);

/*
tree3: 
[
  {
    children: [
      {
        children: [{ children: [], id: 3, parentId: 2, title: "node-1-2-3" }],
        id: 2,
        parentId: 1,
        title: "node-1-2"
      }
    ],
    id: 1,
    parentId: 10,
    title: "root-1"
  },
  { children: [], id: 4, parentId: 10, title: "root-4" }
]
*/

API

flatToTree(data, [options])

Parameters

  • data: Array: Flat array to convert
  • options?: Object: Config options:
    • id?: String : Property name of unique node identifier. Default: 'id'.
    • parentId?: String : Property name of parent node id. Default: 'parentId'.
    • children?: String : Property name of an array to store child nodes. Default: 'children'.

Return

  • Array: Converted tree structure

Browser compatibility

  • Chrome 61+

Use Babel for better browser support