Make deepKeys include empty arrays and objects (#105)

Author: AuthorProxy

index.d.ts

@@ -133,7 +133,7 @@ console.log(getProperty(object, escapedPath));
 export function escapePath(path: string): string;
 
 /**
-Returns an array of every path. Plain objects are deeply recursed and are not themselves included.
+Returns an array of every path. Non-empty plain objects and arrays are deeply recursed and are not themselves included.
 
 This can be useful to help flatten an object for an API that only accepts key-value pairs or for a tagged template literal.
 
@@ -148,12 +148,16 @@ const user = {
 		first: 'Richie',
 		last: 'Bendall',
 	},
+	activeTasks: [],
+	currentProject: null
 };
 
 for (const property of deepKeys(user)) {
 	console.log(`${property}: ${getProperty(user, property)}`);
 	//=> name.first: Richie
 	//=> name.last: Bendall
+	//=> activeTasks: []
+	//=> currentProject: null
 }
 ```
 */

index.js

@@ -3,6 +3,8 @@ const isObject = value => {
 	return value !== null && (type === 'object' || type === 'function');
 };
 
+const isEmptyObject = value => isObject(value) && Object.keys(value).length === 0;
+
 const disallowedKeys = new Set([
 	'__proto__',
 	'prototype',
@@ -316,7 +318,7 @@ function stringifyPath(pathSegments) {
 }
 
 function * deepKeysIterator(object, currentPath = []) {
-	if (!isObject(object)) {
+	if (!isObject(object) || isEmptyObject(object)) {
 		if (currentPath.length > 0) {
 			yield stringifyPath(currentPath);
 		}

readme.md

@@ -110,7 +110,7 @@ console.log(getProperty(object, escapedPath));
 
 ### deepKeys(object)
 
-Returns an array of every path. Plain objects are deeply recursed and are not themselves included.
+Returns an array of every path. Non-empty plain objects and arrays are deeply recursed and are not themselves included.
 
 This can be useful to help flatten an object for an API that only accepts key-value pairs or for a tagged template literal.
 
@@ -122,12 +122,16 @@ const user = {
 		first: 'Richie',
 		last: 'Bendall',
 	},
+	activeTasks: [],
+	currentProject: null
 };
 
 for (const property of deepKeys(user)) {
 	console.log(`${property}: ${getProperty(user, property)}`);
 	//=> name.first: Richie
 	//=> name.last: Bendall
+	//=> activeTasks: []
+	//=> currentProject: null
 }
 ```
 

test.js

@@ -413,13 +413,20 @@ test('escapePath', t => {
 
 test('deepKeys', t => {
 	const object = {
+		eo: {},
+		ea: [],
 		'a.b': {
 			c: {
 				d: [1, 2, {
 					g: 3,
 				}],
 				e: '🦄',
 				f: 0,
+				h: {},
+				i: [],
+				nu: null,
+				na: Number.NaN,
+				un: undefined,
 			},
 			'': {
 				a: 0,
@@ -432,11 +439,18 @@ test('deepKeys', t => {
 	const keys = deepKeys(object);
 
 	t.deepEqual(keys, [
+		'eo',
+		'ea',
 		'a\\.b.c.d[0]',
 		'a\\.b.c.d[1]',
 		'a\\.b.c.d[2].g',
 		'a\\.b.c.e',
 		'a\\.b.c.f',
+		'a\\.b.c.h',
+		'a\\.b.c.i',
+		'a\\.b.c.nu',
+		'a\\.b.c.na',
+		'a\\.b.c.un',
 		'a\\.b..a',
 		'.a',
 	]);