Rename nodesField config key to childrenField

Author: philipstanislaus

README.md

@@ -61,8 +61,8 @@ 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"`
-- `nodesField`: key which will contain all child nodes of the parent node . Default: `"children"`
 
 Example:
 
@@ -73,7 +73,7 @@ const tree = arrayToTree([
     { num: '1941', ref: '418', custom: 'de' },
     { num: '1', ref: '418', custom: 'ZZZz' },
     { num: '418', ref: null, custom: 'ü'},
-], { id: 'num', parentId: 'ref', nodesField: 'nodes' })
+], { id: 'num', parentId: 'ref', childrenField: 'nodes' })
 ```
 
 Which produces:

build/arrayToTree.d.ts

@@ -12,7 +12,7 @@ export interface Config {
     id: string;
     parentId: string;
     dataField: string | null;
-    nodesField: string;
+    childrenField: string;
 }
 /**
  * Unflattens an array to a tree with runtime O(n)

build/arrayToTree.js

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

build/arrayToTree.js.map

@@ -14,14 +14,14 @@ export interface Config {
   id: string,
   parentId: string,
   dataField: string | null,
-  nodesField: string
+  childrenField: string
 }
 
 const defaultConfig: Config = {
   id: 'id',
   parentId: 'parentId',
   dataField: 'data',
-  nodesField: 'children',
+  childrenField: 'children',
 }
 
 /**
@@ -47,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] = { [conf.nodesField]: [] }
+      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, [conf.nodesField]: lookup[itemId][conf.nodesField] }
+      lookup[itemId] = { ...item, [conf.childrenField]: lookup[itemId][conf.childrenField] }
     }
 
     const TreeItem = lookup[itemId]
@@ -68,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] = { [conf.nodesField]: [] }
+        lookup[parentId] = { [conf.childrenField]: [] }
       }
 
       // add the current item to the parent
-      lookup[parentId][conf.nodesField].push(TreeItem)
+      lookup[parentId][conf.childrenField].push(TreeItem)
     }
   }