@ptolemy2002/react-mount-effects 2.0.0 → 2.1.0

package/README.md

@@ -36,10 +36,10 @@ None
 
 ### useDelayedEffect
 #### Description
-Runs the callback only after it has been triggered `delay + 1` times (since the first is on mount and does not represent a state change). The return value of the callback is ignored.
+Runs the callback only after it has been triggered `delay + 1` times (since the first is on mount and does not represent a state change). The return value of the callback is used as the cleanup function for the effect.
 
 #### Parameters
-- `callback` (`(changeCount: number, reset: () => void) => void`): The callback to run after the delay. The first parameter is the number of times the effect has been triggered since either initialization or last reset, and the second argument is a function that allows you to reset the counter.
+- `callback` (`changeCount: number, reset: () => void) => (() => void) | undefined`): The callback to run after the delay. The first parameter is the number of times the effect has been triggered since either initialization or last reset, and the second argument is a function that allows you to reset the counter.
 - `deps` (`react.DependencyList`): An array of dependencies to listen to. This works exactly like the `useEffect` hook's dependencies. By default, this is an empty array.
 - `delay` (`number`): The number of times the dependencies must change before the callback is run. Default is `0`, meaning the callback is run on any change, but not on mount.
 

package/dist/main.d.ts

@@ -1,4 +1,4 @@
-import { DependencyList } from 'react';
+import { DependencyList, EffectCallback } from 'react';
 export declare function useMountEffect(callback: () => void): void;
 export declare function useUnmountEffect(callback: () => void): void;
-export declare function useDelayedEffect(callback: (changeCount: number, reset: () => void) => void, deps?: DependencyList, delay?: number): void;
+export declare function useDelayedEffect(callback: (changeCount: number, reset: () => void) => ReturnType<EffectCallback>, deps?: DependencyList, delay?: number): void;

package/dist/main.js

@@ -10,7 +10,7 @@ function s(e) {
 function i(e, u = [], f = 0) {
   const t = c(0);
   n(() => {
-    t.current++, t.current > f + 1 && e(t.current, () => t.current = 0);
+    if (t.current++, t.current > f + 1) return e(t.current, () => t.current = 0);
   }, u);
 }
 export {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ptolemy2002/react-mount-effects",
   "private": false,
-  "version": "2.0.0",
+  "version": "2.1.0",
   "type": "module",
   "repository": {
     "type": "git",