Merge pull request #16 from philipstanislaus/SpawnAtis-master

Add childrenField option

Author: philipstanislaus

README.md

@@ -61,6 +61,7 @@ You can provide a second argument to arrayToTree with configuration options. Rig
 
 - `id`: key of the id field of the item. Default: `"id"`
 - `parentId`: key of the parent's id field of the item. Default: `"parentId"`
+- `childrenField`: key which will contain all child nodes of the parent node. Default: `"children"`
 - `dataField`: key which will contain all properties/data of the original items. Set to null if you don't want a container. Default: `"data"`
 
 Example:
@@ -72,19 +73,19 @@ const tree = arrayToTree([
     { num: '1941', ref: '418', custom: 'de' },
     { num: '1', ref: '418', custom: 'ZZZz' },
     { num: '418', ref: null, custom: 'ü'},
-], { id: 'num', parentId: 'ref' })
+], { id: 'num', parentId: 'ref', childrenField: 'nodes' })
 ```
 
 Which produces:
 
 ```js
 [
-    { data: { num: '4', ref: null, custom: 'abc' }, children: [
-        { data: { num: '31', ref: '4', custom: '12' }, children: [] },
+    { data: { num: '4', ref: null, custom: 'abc' }, nodes: [
+        { data: { num: '31', ref: '4', custom: '12' }, nodes: [] },
     ] },
-    { data: { num: '418', ref: null, custom: 'ü'}, children: [
-        { data: { num: '1941', ref: '418', custom: 'de' }, children: [] },
-        { data: { num: '1', ref: '418', custom: 'ZZZz' }, children: [] },
+    { data: { num: '418', ref: null, custom: 'ü'}, nodes: [
+        { data: { num: '1941', ref: '418', custom: 'de' }, nodes: [] },
+        { data: { num: '1', ref: '418', custom: 'ZZZz' }, nodes: [] },
     ] },
 ]
 ```

build/arrayToTree.d.ts

@@ -6,13 +6,13 @@ export interface Item {
 export interface TreeItem {
     id?: string | number;
     parentId?: string | number | null;
-    [key: string]: Item | any;
-    children: TreeItem[];
+    [key: string]: Item | TreeItem[] | any;
 }
 export interface Config {
     id: string;
     parentId: string;
     dataField: string | null;
+    childrenField: string;
 }
 /**
  * Unflattens an array to a tree with runtime O(n)

build/arrayToTree.js

@@ -55,17 +55,17 @@ describe('arrayToTree', () => {
         { num: '1', ref: '418', custom: 'ZZZz' },
         { num: '418', ref: null, custom: 'ü' },
       ]),
-      { id: 'num', parentId: 'ref' },
+      { id: 'num', parentId: 'ref', childrenField: 'nodes' },
     )).to.deep.equal([
       {
-        data: { num: '4', ref: null, custom: 'abc' }, children: [
-          { data: { num: '31', ref: '4', custom: '12' }, children: [] },
+        data: { num: '4', ref: null, custom: 'abc' }, nodes: [
+          { data: { num: '31', ref: '4', custom: '12' }, nodes: [] },
         ],
       },
       {
-        data: { num: '418', ref: null, custom: 'ü' }, children: [
-          { data: { num: '1941', ref: '418', custom: 'de' }, children: [] },
-          { data: { num: '1', ref: '418', custom: 'ZZZz' }, children: [] },
+        data: { num: '418', ref: null, custom: 'ü' }, nodes: [
+          { data: { num: '1941', ref: '418', custom: 'de' }, nodes: [] },
+          { data: { num: '1', ref: '418', custom: 'ZZZz' }, nodes: [] },
         ],
       },
     ])

build/arrayToTree.js.map

@@ -7,20 +7,21 @@ export interface Item {
 export interface TreeItem {
   id?: string | number,
   parentId?: string | number | null,
-  [key: string]: Item | any,
-  children: TreeItem[]
+  [key: string]: Item | TreeItem[] | any,
 }
 
 export interface Config {
   id: string,
   parentId: string,
   dataField: string | null,
+  childrenField: string
 }
 
 const defaultConfig: Config = {
   id: 'id',
   parentId: 'parentId',
   dataField: 'data',
+  childrenField: 'children',
 }
 
 /**
@@ -46,14 +47,14 @@ export function arrayToTree (items: Item[], config: Partial<Config> = {}): TreeI
     // look whether item already exists in the lookup table
     if (!Object.prototype.hasOwnProperty.call(lookup, itemId)) {
       // item is not yet there, so add a preliminary item (its data will be added later)
-      lookup[itemId] = { children: [] }
+      lookup[itemId] = { [conf.childrenField]: [] }
     }
 
     // add the current item's data to the item in the lookup table
     if (conf.dataField) {
       lookup[itemId][conf.dataField] = item
     } else {
-      lookup[itemId] = { ...item, children: lookup[itemId].children }
+      lookup[itemId] = { ...item, [conf.childrenField]: lookup[itemId][conf.childrenField] }
     }
 
     const TreeItem = lookup[itemId]
@@ -67,11 +68,11 @@ export function arrayToTree (items: Item[], config: Partial<Config> = {}): TreeI
       // look whether the parent already exists in the lookup table
       if (!Object.prototype.hasOwnProperty.call(lookup, parentId)) {
         // parent is not yet there, so add a preliminary parent (its data will be added later)
-        lookup[parentId] = { children: [] }
+        lookup[parentId] = { [conf.childrenField]: [] }
       }
 
       // add the current item to the parent
-      lookup[parentId].children.push(TreeItem)
+      lookup[parentId][conf.childrenField].push(TreeItem)
     }
   }