Add support for top-level arrays (#15)

Co-authored-by: Sindre Sorhus <[email protected]>

index.d.ts

@@ -36,11 +36,19 @@ sortKeys({c: 0, a: 0, b: 0}, {
 	compare: (a, b) => -a.localeCompare(b)
 });
 //=> {c: 0, b: 0, a: 0}
+
+sortKeys([{b: 0, a:2}], {deep: true});
+//=> [{a: 2, b: 0}]
 ```
 */
 declare function sortKeys<T extends {[key: string]: any}>(
 	object: T,
 	options?: sortKeys.Options
 ): T;
 
+declare function sortKeys<T>(
+	object: Array<T>,
+	options?: sortKeys.Options
+): Array<T>;
+
 export = sortKeys;

index.js

@@ -2,8 +2,8 @@
 const isPlainObject = require('is-plain-obj');
 
 module.exports = (object, options = {}) => {
-	if (!isPlainObject(object)) {
-		throw new TypeError('Expected a plain object');
+	if (!isPlainObject(object) && !Array.isArray(object)) {
+		throw new TypeError('Expected a plain object or array');
 	}
 
 	const {deep} = options;
@@ -63,5 +63,9 @@ module.exports = (object, options = {}) => {
 		return result;
 	};
 
+	if (Array.isArray(object)) {
+		return deep ? deepSortArray(object) : object.slice();
+	}
+
 	return sortKeys(object);
 };

index.test-d.ts

@@ -7,6 +7,9 @@ expectType<{a: 0; b: 0; c: 0}>(sortKeys({c: 0, a: 0, b: 0}));
 expectType<{a: 0; b: {a: 0; b: 0}}>(
 	sortKeys({b: {b: 0, a: 0}, a: 0}, {deep: true})
 );
+expectType<Array<{a: 0; b: 0}>>(
+	sortKeys([{a: 0, b: 0}, {b: 0, a: 0}], {deep: true})
+);
 expectType<{c: 0; b: 0; a: 0}>(
 	sortKeys(
 		{c: 0, a: 0, b: 0},

readme.md

@@ -30,6 +30,9 @@ sortKeys({c: 0, a: 0, b: 0}, {
 	compare: (a, b) => -a.localeCompare(b)
 });
 //=> {c: 0, b: 0, a: 0}
+
+sortKeys([{b: 0, a:2}], {deep: true});
+//=> [{a: 2, b: 0}]
 ```
 
 
@@ -41,7 +44,7 @@ Returns a new object with sorted keys.
 
 #### object
 
-Type: `object`
+Type: `object | Array`
 
 #### options
 

test.js

@@ -76,3 +76,18 @@ test('deep arrays', t => {
 	t.deepEqual(Object.keys(sorted.a[0]), ['a', 'b']);
 	t.deepEqual(Object.keys(sorted.a[1][0]), ['a', 'b']);
 });
+
+test('top-level array', t => {
+	const array = [{b: 0, a: 0}, {c: 0, d: 0}];
+	const sorted = sortKeys(array);
+	t.not(sorted, array, 'should make a copy');
+	t.is(sorted[0], array[0]);
+	t.is(sorted[1], array[1]);
+
+	const deepSorted = sortKeys(array, {deep: true});
+	t.not(deepSorted, array);
+	t.not(deepSorted[0], array[0]);
+	t.not(deepSorted[1], array[1]);
+	t.deepEqual(Object.keys(deepSorted[0]), ['a', 'b']);
+	t.deepEqual(Object.keys(deepSorted[1]), ['c', 'd']);
+});