Add some javadoc to update

2015-08-01 23:38:27 -07:00 · 2015-08-01 23:38:27 -07:00 · f199cd335a
commit f199cd335a
parent 54137398ea
1 changed files with 4 additions and 0 deletions
--- a/lib/update.js
+++ b/lib/update.js
@ -39,6 +39,10 @@ function updateArray(updates, obj) {
 * Or with a function:
 * update({ foo: x => (x + 1) }, { foo: 2 });
 * // => { foo: 3 }
+ *
+ * @param {Object|Function} updates
+ * @param {Object|Array}    object to update
+ * @return {Object|Array}   new object with modifications
 */
 function update(updates, obj) {
  if (typeof updates === 'function') {