mutex optional second param

dmonad · Apr 24, 2019 · ec2be4f · ec2be4f
1 parent 13a17e4
commit ec2be4f
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/mutex.js b/mutex.js
@@ -1,4 +1,10 @@
 
+/**
+ * @callback mutex
+ * @param {function():void} cb Only executed when this mutex is not in the current stack
+ * @param {function():void} [elseCb] Executed when this mutex is in the current stack
+ */
+
 /**
  * Creates a mutual exclude function with the following property:
  *
@@ -11,7 +17,7 @@
  *   })
  * })
  *
- * @return {function(function():void,function():void):void} A mutual exclude function
+ * @return {mutex} A mutual exclude function
  * @public
  */
 export const createMutex = () => {