Expose cancel method for useAsyncEffect hook;

Author: DigitalBrainJS

lib/use-async-effect.js

@@ -27,6 +27,11 @@ const removeElement = (arr, element) => {
 /**
  * @typedef {function} UseAsyncEffectCancelFn
  * @param {string} [reason]
+ * @property {Boolean} done
+ * @property {*} result
+ * @property {*} error
+ * @property {boolean} canceled
+ * @property {UseAsyncEffectCancelFn} cancel
  * @property {PauseFn} pause
  * @property {ResumeFn} resume
  * returns {boolean}
@@ -46,15 +51,15 @@ const removeElement = (arr, element) => {
 
 /**
  * AsyncEffect hook to define cancellable effects
- * @param {GeneratorFunction} generator
+ * @param {GeneratorFunction} generatorFn
  * @param {object} [options]
  * @param {deps} [options.deps= []]
  * @param {boolean} [options.skipFirst= false]
  * @param {boolean} [options.states= false]
  * @param {boolean} [options.once= false]
  * @returns {UseAsyncEffectCancelFn}
  */
-const useAsyncEffect = (generator, options) => {
+const useAsyncEffect = (generatorFn, options) => {
     let {current} = useRef({});
 
     let {
@@ -74,7 +79,7 @@ const useAsyncEffect = (generator, options) => {
 
     const [state, setState] = states ? useAsyncDeepState(initialState, {watch: false}) : [];
 
-    if (!isGeneratorFn(generator)) {
+    if (!isGeneratorFn(generatorFn)) {
         throw TypeError('useAsyncEffect requires a generator as the first argument');
     }
 
@@ -120,7 +125,7 @@ const useAsyncEffect = (generator, options) => {
 
         states && setState(initialState);
 
-        let promise = current.promise = CPromise.run(generator, {resolveSignatures: true, scopeArg: true})
+        let promise = current.promise = CPromise.run(generatorFn, {resolveSignatures: true, scopeArg: true})
         .then(result => {
 
             current.done = true;
@@ -186,6 +191,7 @@ const useAsyncEffect = (generator, options) => {
         cancel.error = state.error;
         cancel.canceled = state.canceled;
         cancel.paused = state.paused;
+        cancel.cancel= cancel;
     }
 
     return cancel;
@@ -270,7 +276,7 @@ const asyncEffectFactory= (options) => {
 
 /**
  * useAsyncCallback hook for defining cancellable async routines
- * @param {GeneratorFunction} generator
+ * @param {GeneratorFunction} generatorFn
  * @param {object|array} [options]
  * @param {array} [options.deps= []]
  * @param {boolean} [options.combine= false]
@@ -282,7 +288,7 @@ const asyncEffectFactory= (options) => {
  * @param {boolean} [options.catchErrors= true]
  * @returns {UseAsyncCallbackDecoratedFn}
  */
-const useAsyncCallback = (generator, options) => {
+const useAsyncCallback = (generatorFn, options) => {
     const current = useFactory(asyncEffectFactory, [options]);
 
     let {
@@ -327,7 +333,7 @@ const useAsyncCallback = (generator, options) => {
                 }
             }
 
-            const resolveGenerator = () => CPromise.run(generator, {args, resolveSignatures: true, scopeArg});
+            const resolveGenerator = () => CPromise.run(generatorFn, {args, resolveSignatures: true, scopeArg});
 
             cancelPrevious && !combine && cancel(E_REASON_RESTART);