@taoqf/array-to-tree
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.3 • Public • Published

    array-to-tree

    Build Status Dependency Status

    array-to-tree

    Convert a plain array of nodes (with pointers to parent nodes) to a nested data structure.

    Solves a problem with conversion of retrieved from a database sets of data to a nested data structure (i.e. navigation tree).

    Installation

    $ npm install array-to-tree --save
    

    Usage

    var arrayToTree = require('array-to-tree');
    
    var dataOne = [{
      id: 1,
      name: "Portfolio",
      parent_id: undefined
    }, {
      id: 2,
      name: "Web Development",
      parent_id: 1
    }, {
      id: 3,
      name: "Recent Works",
      parent_id: 2
    }, {
      id: 4,
      name: "About Me",
      parent_id: undefined
    }];
    
    arrayToTree(dataOne);
    
    /*
     * Output:
     *
     * Portfolio
     *   Web Development
     *     Recent Works
     * About Me
     */
    
    var dataTwo = [{
      _id: 'ec654ec1-7f8f-11e3-ae96-b385f4bc450c',
      name: "Portfolio",
      parent: null
    }, {
      _id: 'ec666030-7f8f-11e3-ae96-0123456789ab',
      name: "Web Development",
      parent: 'ec654ec1-7f8f-11e3-ae96-b385f4bc450c'
    }, {
      _id: 'ec66fc70-7f8f-11e3-ae96-000000000000',
      name: "Recent Works",
      parent: 'ec666030-7f8f-11e3-ae96-0123456789ab'
    }, {
      _id: '32a4fbed-676d-47f9-a321-cb2f267e2918',
      name: "About Me",
      parent: null
    }];
    
    arrayToTree(dataTwo, {
      parentProperty: 'parent',
      customID: '_id'
    });
    
    /*
     * Output:
     *
     * Portfolio
     *   Web Development
     *     Recent Works
     * About Me
     */

    API

    arrayToTree(data, [options])

    Convert a plain array of nodes (with pointers to parent nodes) to a a nested data structure.

    Parameters

    • Array data: An array of data
    • Object options: An object containing the following fields:
      • parentProperty (String): A name of a property where a link to a parent node could be found. Default: 'parent_id'
      • customID (String): An unique node identifier. Default: 'id'

    Return

    • Array: Result of transformation

    License

    MIT © Philipp Alferov

    Install

    npm i @taoqf/array-to-tree

    DownloadsWeekly Downloads

    2

    Version

    0.0.3

    License

    MIT

    Unpacked Size

    84.1 kB

    Total Files

    17

    Last publish

    Collaborators

    • taoqf