feat(util): add helper to check if object has specific keys

Ovidiu Barabula · Ovidiu Barabula · commit 4356d3d2f90c · 2018-03-26T15:36:51.000+03:00
diff --git a/src/util/utility-functions.spec.ts b/src/util/utility-functions.spec.ts
@@ -14,6 +14,7 @@ import {
   required,
   retry,
   sleep,
+  hasAllKeys,
 } from './utility-functions';
 
 describe('Utility Functions', () => {
@@ -345,4 +346,42 @@ describe('Utility Functions', () => {
       assert.throws(() => required(1), ERRORS.REQUIRED_NEEDS_MESSAGE);
     });
   });
+
+
+  describe('hasAllKeys()', () => {
+    const subject = {
+      keyA: 'valueA',
+      keyB: 'valueB',
+      keyC: 'valueC',
+    };
+
+    it('returns true if object contains all keys', () => {
+      expect(hasAllKeys(subject, 'keyA', 'keyB', 'keyC')).to.be.true;
+    });
+
+
+    it('returns false if object doesn\'t contain all keys', () => {
+      expect(hasAllKeys(subject, 'keyA', 'keyB', 'keyC', 'keyD')).to.be.false;
+    });
+
+
+    it('throws if called without parameters', () => {
+      assert.throws(() => hasAllKeys(), ERRORS.HAS_ALL_KEYS_NEEDS_OBJECT);
+    });
+
+
+    it('throws if first parameter is not an object', () => {
+      assert.throws(() => hasAllKeys(false), ERRORS.HAS_ALL_KEYS_NEEDS_OBJECT);
+    });
+
+
+    it('throws if rest params are not passed', () => {
+      assert.throws(() => hasAllKeys(subject), ERRORS.HAS_ALL_KEYS_NEEDS_KEYS_ARRAY);
+    });
+
+
+    it('throws if rest params are not strings', () => {
+      assert.throws(() => hasAllKeys(subject, 'keyA', 1, true), ERRORS.HAS_ALL_KEYS_NEEDS_KEYS_ARRAY);
+    });
+  });
 });
diff --git a/src/util/utility-functions.ts b/src/util/utility-functions.ts
@@ -36,6 +36,10 @@ export const ERRORS = {
 
   // required()
   REQUIRED_NEEDS_MESSAGE: 'required() requires first argument <message> of type \'string\'',
+
+  // hasAllKeys()
+  HAS_ALL_KEYS_NEEDS_KEYS_ARRAY: 'hasAllKeys() requires rest argument(s) <key> of type \'string\'',
+  HAS_ALL_KEYS_NEEDS_OBJECT: 'hasAllKeys() requires first argument <object> of type \'object\'',
 };
 
 
@@ -265,3 +269,22 @@ export function required<T>(message: string): T {
 
   throw new Error(message);
 }
+
+
+/**
+ * Check if passed object as all the keys in the keys array
+ * @param object Object to be tested
+ * @param keys Array of keys
+ */
+export function hasAllKeys(
+  object: ({[key: string]: any}) = required(ERRORS.HAS_ALL_KEYS_NEEDS_OBJECT),
+  ...keys: string[],
+): boolean {
+  if (typeof object !== 'object') {
+    return required(ERRORS.HAS_ALL_KEYS_NEEDS_OBJECT);
+  } else if (keys.length === 0 || !keys.every(item => typeof item === 'string')) {
+    return required(ERRORS.HAS_ALL_KEYS_NEEDS_KEYS_ARRAY);
+  }
+
+  return keys.every(key => hasNested(object, key));
+}
diff --git a/types/util/utility-functions.d.ts b/types/util/utility-functions.d.ts
@@ -15,6 +15,8 @@ export declare const ERRORS: {
     RETRY_NEEDS_OPTIONS_TO_BE_OBJECT: string;
     RETRY_RETRIES_CANNOT_BE_ZERO: string;
     REQUIRED_NEEDS_MESSAGE: string;
+    HAS_ALL_KEYS_NEEDS_KEYS_ARRAY: string;
+    HAS_ALL_KEYS_NEEDS_OBJECT: string;
 };
 /**
  * Check object for path
@@ -64,3 +66,11 @@ export declare function retry(fn: AnyFunction, options?: {
  * @param message Custom error message
  */
 export declare function required<T>(message: string): T;
+/**
+ * Check if passed object as all the keys in the keys array
+ * @param object Object to be tested
+ * @param keys Array of keys
+ */
+export declare function hasAllKeys(object?: ({
+    [key: string]: any;
+}), ...keys: string[]): boolean;
