Merge pull request #33 from mrodrig/feat/add-arrayIndexesAsKeys

Add arrayIndexesAsKeys option

Author: mrodrig

README.md

@@ -48,6 +48,24 @@ The array of keys that is returned can then be used with the
 at a specific key path.
 
 Options (optional):
+- arrayIndexesAsKeys - `Boolean` (Default `false`) - Should array indexes be used as keys in the generated path?
+	- Example:
+	```json
+	[
+		{
+			"list": [
+				{
+					"a": 1
+				},
+				{
+					"a": 2
+				}
+			]
+		}
+	]
+	```
+	- arrayIndexesAsKeys = `false` results in: `['list.a']`
+	- arrayIndexesAsKeys = `true` results in: `['list.0.a', 'list.1.a']`
 - expandNestedObjects - `Boolean` (Default: `true`) - Should nested objects appearing in the provided object also be expanded, such asthat keys appearing in those objects are extracted and included in the returned key path list?
 	- Example:
 	```json

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "deeks",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Retrieve all keys and nested keys from objects and arrays of objects.",
   "main": "lib/deeks.js",
   "types": "lib/deeks.d.ts",

package.json

@@ -42,7 +42,7 @@ function generateDeepKeysList(heading: string, data: Record<string, unknown>, op
         const keyName = buildKeyName(heading, escapeNestedDotsIfSpecified(currentKey, options));
 
         // If we have another nested document, recur on the sub-document to retrieve the full key name
-        if (options.expandNestedObjects && utils.isDocumentToRecurOn(data[currentKey])) {
+        if (options.expandNestedObjects && utils.isDocumentToRecurOn(data[currentKey]) || (options.arrayIndexesAsKeys && Array.isArray(data[currentKey]) && (data[currentKey] as unknown[]).length)) {
             return generateDeepKeysList(keyName, data[currentKey] as Record<string, unknown>, options);
         } else if (options.expandArrayObjects && Array.isArray(data[currentKey])) {
             // If we have a nested array that we need to recur on
@@ -107,6 +107,7 @@ function buildKeyName(upperKeyName: string, currentKeyName: string) {
 
 function mergeOptions(options: DeeksOptions | undefined): DeeksOptions {
     return {
+        arrayIndexesAsKeys: false,
         expandNestedObjects: true,
         expandArrayObjects: false,
         ignoreEmptyArraysWhenExpanding: false,

src/deeks.ts

@@ -1,6 +1,9 @@
 'use strict';
 
 export interface DeeksOptions {
+    /** @default false */
+    arrayIndexesAsKeys?: boolean,
+
     /** @default true */
     expandNestedObjects?: boolean,
 

src/types.ts

@@ -401,6 +401,25 @@ describe('deeks Module', () => {
                 assert.deepEqual(keys, ['a.c.f']);
                 done();
             });
+
+            it('[arrayIndexesAsKeys] should properly use array indexes as keys when specified', (done) => {
+                const testObj = {
+                        list: [{
+                            a: 1
+                        }, {
+                            a: 2
+                        }]
+                    },
+                    options = {
+                        arrayIndexesAsKeys: true
+                    },
+                    keys = deepKeys(testObj, options);
+
+                assert.equal(Array.isArray(keys), true);
+                assert.equal(keys.length, 2);
+                assert.deepEqual(keys, ['list.0.a', 'list.1.a']);
+                done();
+            });
         });
     });
 
@@ -883,6 +902,25 @@ describe('deeks Module', () => {
                 assert.deepEqual(keys, [ ['a.c.f'] ]);
                 done();
             });
+
+            it('[arrayIndexesAsKeys] should properly use array indexes as keys when specified', (done) => {
+                const testList = [{
+                        list: [{
+                            a: 1
+                        }, {
+                            a: 2
+                        }]
+                    }],
+                    options = {
+                        arrayIndexesAsKeys: true
+                    },
+                    keys = deepKeysFromList(testList, options);
+
+                assert.equal(Array.isArray(keys), true);
+                assert.equal(keys.length, 1);
+                assert.deepEqual(keys, [ ['list.0.a', 'list.1.a'] ]);
+                done();
+            });
         });
     });
 });