Socket
Socket
Sign inDemoInstall

hierarchy-js

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

hierarchy-js

Elegant and lightweight library for working with data structures


Version published
Weekly downloads
98
increased by44.12%
Maintainers
1
Weekly downloads
 
Created
Source

HierarchyJS

Elegant and lightweight library for working with data structures

npm version Build Status codecov

Features
  • Creating a tree structure from a flat list
  • Creating a flat list from a tree structure
  • Flexible parametrization

Install

npm install hierarchy-js

Methods

  • createTreeHierarchy (elements, options)
  • createFlatHierarchy (elements, options)
  • elements, [] - the array on which the passage is carried out.
  • options, {} - props for parametrization

Default options

    {
      id: 'id', // find item by this key
      parentId: 'parentId', // find parent by this key
      children: 'children', // create or find children by this key
      excludeParent: false, // if `true`, not include root parents to result
      saveExtractedChildren: false, // if `true`, not delete children list from descendants
    }

How to use

Tree structure with default options
    import { createTreeHierarchy } from 'hierarchy-js'

    const flatList = [
       { id: 1 },
       { id: 2, parentId: 1 },
       { id: 3, parentId: 2 },
       { id: 4, parentId: 'any' },
    ]

    const tree = createTreeHierarchy(flatList)

    // tree
    [
      {
        "id": 1,
        "children": [
          {
            "id": 2,
            "parentId": 1,
            "children": [
              {
                "id": 3,
                "parentId": 2
              }
            ]
          }
        ]
      },
      {
        "id": 4,
        "parentId": "any"
      }
    ]
Flat list with options
    import { createFlatHierarchy } from 'hierarchy-js'

    const options = {
      id: 'itemId',
      parentId: 'parentItemId',
      children: 'items',
    }

    const tree = [
      {
        itemId: 1,
        items: [
          {
            itemId: 2,
            parentItemId: 1,
            items: [
              {
                itemId: 3,
                parentItemId: 2,
              },
            ],
          },
        ],
      },
      {
        itemId: 4,
        parentItemId: 'any',
      },
    ]

    const faltList = createFlatHierarchy(tree, options)

    // faltList
    [
      { itemId: 1 },
      { itemId: 2, parentItemId: 1 },
      { itemId: 3, parentItemId: 2 },
      { itemId: 4, parentItemId: 'any' },
    ]
Tests
npm test

Keywords

FAQs

Package last updated on 03 Dec 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc