feat(util): add utility function for object key sorting

Ovidiu Barabula · Ovidiu Barabula · commit 99de4693046c · 2018-05-08T10:08:17.000+03:00
diff --git a/src/util/utility-functions.spec.ts b/src/util/utility-functions.spec.ts
@@ -20,6 +20,7 @@ import {
   required,
   retry,
   sleep,
+  sortObjectKeys,
 } from './utility-functions';
 
 describe('Utility Functions', () => {
@@ -526,4 +527,24 @@ describe('Utility Functions', () => {
       expect(getPrefix('foo')).to.equal('foo');
     });
   });
+
+
+  describe('sortObjectKeys()', () => {
+    it('returns the sorted object', () => {
+      expect(Object.keys(sortObjectKeys({ c: 3, b: 2, a: 1 })))
+        .to.deep.equal(Object.keys({ a: 1, b: 2, c: 3 }));
+    });
+
+
+    it('returns sorted object if already sorted', () => {
+      expect(Object.keys(sortObjectKeys({ a: 1, b: 2, c: 3 })))
+        .to.deep.equal(Object.keys({ a: 1, b: 2, c: 3 }));
+    });
+
+
+    it('returns empty object, if empty object is passed in', () => {
+      expect(sortObjectKeys({}))
+        .to.deep.equal({});
+    });
+  });
 });
diff --git a/src/util/utility-functions.ts b/src/util/utility-functions.ts
@@ -7,6 +7,10 @@
 
 import Logger, { ILogger } from './logger';
 
+
+export interface AnyObject {
+  [key: string]: any;
+}
 export interface NestedObject {
   [key: string]: any;
 }
@@ -396,3 +400,16 @@ export function arrayOf(array: any[], ...types: string[]): boolean {
     return types.includes(typeof item);
   });
 }
+
+
+/**
+ * Alphabetically sort object keys
+ * @param object Object to be sorted
+ */
+export function sortObjectKeys(object: AnyObject): AnyObject {
+  return Object.keys(object).sort()
+    .reduce((sortedObject, key) => ({
+      ...sortedObject,
+      [key]: object[key],
+    }), {});
+}
