Fixed jsdoc docs;

DigitalBrainJS · Nov 22, 2020 · b49520a · b49520a
1 parent 25e2b0a
commit b49520a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -711,10 +711,9 @@ emits the event
 <a name="module_CPromise..CPromise+emitHook"></a>
 
 #### cPromise.emitHook(type, ...args) ⇒ <code>Boolean</code>
-emits the hook event
+emits event as a hook. If some listener return true, this method will immediately return true as the result.Else if some listener returns false the method will return false after invoking all the listeners
 
 **Kind**: instance method of [<code>CPromise</code>](#module_CPromise..CPromise)  
-**Returns**: <code>Boolean</code> - - false if some listener returned false  
 
 | Param | Type |
 | --- | --- |

diff --git a/lib/c-promise.js b/lib/c-promise.js
@@ -1368,10 +1368,11 @@ class CPromise extends Promise {
     }
 
     /**
-     * emits the hook event
+     * emits event as a hook. If some listener return true, this method will immediately return true as the result.
+     * Else if some listener returns false the method will return false after invoking all the listeners
      * @param {EventType} type
      * @param args
-     * @returns {Boolean} - false if some listener returned false
+     * @returns {Boolean}
      */
 
     emitHook(type, ...args) {