redux-devtools/packages/map2tree
renovate[bot] d28e05f156
chore(deps): update all non-major dependencies (#1177)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2022-06-06 08:34:50 -04:00
..
src Add ESM builds (#997) 2022-01-10 15:41:53 +00:00
test Use types in tscnofig to explicitly define global types (#1045) 2022-01-22 21:51:27 +00:00
.eslintignore Imprrove ability to tree-shake libraries (#1050) 2022-01-24 02:11:46 +00:00
.eslintrc.js Use types in tscnofig to explicitly define global types (#1045) 2022-01-22 21:51:27 +00:00
babel.config.esm.json Imprrove ability to tree-shake libraries (#1050) 2022-01-24 02:11:46 +00:00
babel.config.json Imprrove ability to tree-shake libraries (#1050) 2022-01-24 02:11:46 +00:00
CHANGELOG.md Cleanup existing changelogs and add major versions 2022-01-30 17:31:00 -05:00
jest.config.js Use types in tscnofig to explicitly define global types (#1045) 2022-01-22 21:51:27 +00:00
LICENSE.md Merge map2tree package (#426) 2018-12-19 16:50:39 +02:00
package.json chore(deps): update all non-major dependencies (#1177) 2022-06-06 08:34:50 -04:00
README.md chore(*): make more packages scoped (#692) 2020-12-21 15:46:28 -05:00
rollup.config.js Imprrove ability to tree-shake libraries (#1050) 2022-01-24 02:11:46 +00:00
tsconfig.json Imprrove ability to tree-shake libraries (#1050) 2022-01-24 02:11:46 +00:00
tsconfig.test.json Use types in tscnofig to explicitly define global types (#1045) 2022-01-22 21:51:27 +00:00

A pure function to convert a map into a tree structure. Created by @romseguy and merged from romseguy/map2tree.

The following opinions must be taken into account since the primary use case of this library is redux-devtools-chart-monitor:

  • Objects and arrays deeply nested within collections are not converted into a tree structure. See someNestedObject and someNestedArray in the output below, or the corresponding test.
  • Provides support for Immutable.js data structures (only List and Map though).

Usage

map2tree(
  someMap,
  (options = {
    key: 'state', // the name you want for as the root node of the output tree
    pushMethod: 'push', // use 'unshift' to change the order children nodes are added
  })
);

Input

const someMap = {
  someReducer: {
    todos: [
      { title: 'map', someNestedObject: { foo: 'bar' } },
      { title: 'to', someNestedArray: ['foo', 'bar'] },
      { title: 'tree' },
      { title: 'map2tree' },
    ],
    completedCount: 1,
  },
  otherReducer: {
    foo: 0,
    bar: { key: 'value' },
  },
};

Output

{
  name: `${options.key}`,
  children: [
    {
      name: 'someReducer',
      children: [
        {
          name: 'todos',
          children: [
            {
              name: 'todo[0]',
              object: {
                title: 'map',
                someNestedObject: {foo: 'bar'}
              }
            },
            {
              name: 'todo[1]',
              object: {
                title: 'to',
                someNestedArray: ['foo', 'bar']
              }
            },
            // ...
          ]
        },
        // ...
      ]
    },
    {
      name: 'otherReducer',
      children: [
        {
          name: 'foo',
          value: 0
        },
        {
          name: 'bar',
          object: {
            key: 'value'
          }
        }
      ]
    }
  ]
}