📝 Add annotations and description to cachedMerge util function

dev-drprasad · dev-drprasad · commit 10c850de6595 · 2018-05-19T23:12:56.000+05:30
diff --git a/lib/util/cachedMerge.js b/lib/util/cachedMerge.js
@@ -5,11 +5,19 @@
 "use strict";
 
 const mergeCache = new WeakMap();
+
 /**
- * returns something
- * @param {object} first first key
- * @param {object} second second key
- * @returns {WeakMap} new merge
+ * Merges two given objects and caches the result to avoid computation if same objects passed as arguements again.
+ * @example
+ * // performs Object.assign(first, second), stores the result in WeakMap and returns result
+ * cachedMerge({a: 1}, {a: 2})
+ * {a: 2}
+ *  // when same arguments passed, gets the result from WeakMap and returns it.
+ * cachedMerge({a: 1}, {a: 2})
+ * {a: 2}
+ * @param {object} first first object
+ * @param {object} second second object
+ * @returns {object} merged object of first and second object
  */
 const cachedMerge = (first, second) => {
 	let innerCache = mergeCache.get(first);
