From 6991d8f63702cd4ad9237126fd2b174bd3e3e97f Mon Sep 17 00:00:00 2001 From: Jonathan Picques Date: Thu, 1 Sep 2016 23:51:27 +0200 Subject: [PATCH] Updated jsdoc to conform to the jsdoc optional parameters --- lib/index.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/index.js b/lib/index.js index 6d1bb67..93e686e 100644 --- a/lib/index.js +++ b/lib/index.js @@ -27,8 +27,8 @@ AsyncLock.DEFAULT_MAX_PENDING = 1000; * * @param {String|Array} key resource key or keys to lock * @param {function} fn async function - * @param {function} cb (optional) callback function, otherwise will return a promise - * @param {Object} opts (optional) options + * @param {function} [cb] callback function, otherwise will return a promise + * @param {Object} [opts] options */ AsyncLock.prototype.acquire = function(key, fn, cb, opts){ if(Array.isArray(key)){ @@ -211,7 +211,7 @@ AsyncLock.prototype._acquireBatch = function(keys, fn, cb, opts){ /* * Whether there is any running or pending asyncFunc * - * @param {String} key (Optional) + * @param {String} [key] */ AsyncLock.prototype.isBusy = function(key){ if(!key){