use-next-tick 1.1.2 → 1.1.3

package/README.md

@@ -16,13 +16,16 @@ npm install use-next-tick
 
 ```tsx
 "use client";
-import { useState, useRef } from "react";
-import useNextTick from "use-next-tick";
+import { useState, useRef, useLayoutEffect } from "react";
+import useNextTick, {useNextTickLayout} from "use-next-tick";
 
 function MyComponent() {
   const [count, setCount] = useState(0);
   const ref = useRef<HTMLSpanElement>(null);
   const nextTick = useNextTick();
+  /*
+  const nextTick = useNextTickLayout(); // if you need `useLayoutEffect` instead off `useEffect`
+  */
 
   const handleClick = () => {
     setCount((c) => c + 1);
@@ -94,7 +97,7 @@ bun install && bun run build
 ## TypeScript
 
 ```ts
-function useNextTick(): (cb: () => void | Promise<void>) => void;
+export default function useNextTick(useEffectHook?: typeof useEffect | typeof useLayoutEffect): (cb: NextTickCallback) => void;
 ```
 
 Fully typed. Callbacks can be sync or async:

package/dist/index.d.ts

@@ -1,2 +1,4 @@
+import { useLayoutEffect, useEffect } from "react";
 export type NextTickCallback = () => void | Promise<void>;
-export default function useNextTick(): (cb: NextTickCallback) => void;
+export default function useNextTick(useEffectHook?: typeof useEffect | typeof useLayoutEffect): (cb: NextTickCallback) => void;
+export declare function useNextTickLayout(): (cb: NextTickCallback) => void;

package/dist/index.js

@@ -1,4 +1,4 @@
-import{useEffect as i,useRef as r,useCallback as o}from"react";function u(){let e=r([]),c=r(!1);return i(()=>{if(!c.current)return;c.current=!1;let t=e.current;e.current=[];for(let n of t)n()}),o((t)=>{e.current.push(t),c.current=!0},[])}export{u as default};
+import{useRef as r,useCallback as f,useLayoutEffect as a,useEffect as i}from"react";function u(n=i){let e=r([]),t=r(!1);return n(()=>{if(!t.current)return;t.current=!1;let c=e.current;e.current=[];for(let o of c)o()}),f((c)=>{e.current.push(c),t.current=!0},[])}function k(){return u(a)}export{k as useNextTickLayout,u as default};
 
-//# debugId=1994852A3252699764756E2164756E21
+//# debugId=522FAD13C6AB3C0264756E2164756E21
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -2,9 +2,9 @@
   "version": 3,
   "sources": ["../src/index.ts"],
   "sourcesContent": [
-    "import { useEffect, useRef, useCallback } from \"react\";\n\nexport type NextTickCallback = () => void | Promise<void>;\n\nexport default function useNextTick(): (cb: NextTickCallback) => void {\n  const callbacksRef = useRef<NextTickCallback[]>([]);\n  const pendingRef = useRef(false);\n\n  useEffect(() => {\n    if (!pendingRef.current) return;\n\n    pendingRef.current = false;\n    const pending = callbacksRef.current;\n    callbacksRef.current = [];\n    for (const cb of pending) {\n      cb();\n    }\n  });\n\n  const nextTick = useCallback((cb: NextTickCallback) => {\n    callbacksRef.current.push(cb);\n    pendingRef.current = true;\n  }, []);\n\n  return nextTick;\n}\n"
+    "import { useRef, useCallback, useLayoutEffect, useEffect } from \"react\";\n\nexport type NextTickCallback = () => void | Promise<void>;\n\nexport default function useNextTick(\n  useEffectHook: typeof useEffect | typeof useLayoutEffect = useEffect\n): (cb: NextTickCallback) => void {\n  const callbacksRef = useRef<NextTickCallback[]>([]);\n  const pendingRef = useRef(false);\n\n  useEffectHook(() => {\n    if (!pendingRef.current) return;\n\n    pendingRef.current = false;\n    const pending = callbacksRef.current;\n    callbacksRef.current = [];\n    for (const cb of pending) {\n      cb();\n    }\n  });\n\n  const nextTick = useCallback((cb: NextTickCallback) => {\n    callbacksRef.current.push(cb);\n    pendingRef.current = true;\n  }, []);\n\n  return nextTick;\n}\n\nexport function useNextTickLayout() {\n  return useNextTick(useLayoutEffect);\n}\n"
   ],
-  "mappings": "AAAA,oBAAS,YAAW,iBAAQ,cAI5B,SAAwB,CAAW,EAAmC,CACpE,IAAM,EAAe,EAA2B,CAAC,CAAC,EAC5C,EAAa,EAAO,EAAK,EAkB/B,OAhBA,EAAU,IAAM,CACd,GAAI,CAAC,EAAW,QAAS,OAEzB,EAAW,QAAU,GACrB,IAAM,EAAU,EAAa,QAC7B,EAAa,QAAU,CAAC,EACxB,QAAW,KAAM,EACf,EAAG,EAEN,EAEgB,EAAY,CAAC,IAAyB,CACrD,EAAa,QAAQ,KAAK,CAAE,EAC5B,EAAW,QAAU,IACpB,CAAC,CAAC",
-  "debugId": "1994852A3252699764756E2164756E21",
+  "mappings": "AAAA,iBAAS,iBAAQ,qBAAa,eAAiB,cAI/C,SAAwB,CAAW,CACjC,EAA2D,EAC3B,CAChC,IAAM,EAAe,EAA2B,CAAC,CAAC,EAC5C,EAAa,EAAO,EAAK,EAkB/B,OAhBA,EAAc,IAAM,CAClB,GAAI,CAAC,EAAW,QAAS,OAEzB,EAAW,QAAU,GACrB,IAAM,EAAU,EAAa,QAC7B,EAAa,QAAU,CAAC,EACxB,QAAW,KAAM,EACf,EAAG,EAEN,EAEgB,EAAY,CAAC,IAAyB,CACrD,EAAa,QAAQ,KAAK,CAAE,EAC5B,EAAW,QAAU,IACpB,CAAC,CAAC,EAKA,SAAS,CAAiB,EAAG,CAClC,OAAO,EAAY,CAAe",
+  "debugId": "522FAD13C6AB3C0264756E2164756E21",
   "names": []
 }

package/dist/react-native.d.ts

@@ -1,2 +1,3 @@
+import { useEffect, useLayoutEffect } from "react";
 export type NextTickCallback = () => void | Promise<void>;
-export default function useNextTick(): (cb: NextTickCallback) => void;
+export default function useNextTick(useEffectHook?: typeof useEffect | typeof useLayoutEffect): (cb: NextTickCallback) => void;

package/dist/react-native.js

@@ -1,4 +1,4 @@
-import{useEffect as i,useRef as r,useCallback as o}from"react";function u(){let e=r([]),t=r(!1);return i(()=>{if(!t.current)return;t.current=!1;let c=e.current;e.current=[],setTimeout(()=>{for(let n of c)n()},0)}),o((c)=>{e.current.push(c),t.current=!0},[])}export{u as default};
+import{useEffect as n,useRef as r,useCallback as o}from"react";function s(u=n){let e=r([]),t=r(!1);return u(()=>{if(!t.current)return;t.current=!1;let c=e.current;e.current=[],setTimeout(()=>{for(let f of c)f()},0)}),o((c)=>{e.current.push(c),t.current=!0},[])}export{s as default};
 
-//# debugId=3B7FF0A1E8F2680564756E2164756E21
+//# debugId=0A16B9BA1C04CDB964756E2164756E21
 //# sourceMappingURL=react-native.js.map

package/dist/react-native.js.map

@@ -2,9 +2,9 @@
   "version": 3,
   "sources": ["../src/react-native.ts"],
   "sourcesContent": [
-    "import { useEffect, useRef, useCallback } from \"react\";\n\nexport type NextTickCallback = () => void | Promise<void>;\n\nexport default function useNextTick(): (cb: NextTickCallback) => void {\n  const callbacksRef = useRef<NextTickCallback[]>([]);\n  const pendingRef = useRef(false);\n\n  useEffect(() => {\n    if (!pendingRef.current) return;\n\n    pendingRef.current = false;\n    const pending = callbacksRef.current;\n    callbacksRef.current = [];\n    setTimeout(() => {\n      for (const cb of pending) {\n        cb();\n      }\n    }, 0);\n  });\n\n  const nextTick = useCallback((cb: NextTickCallback) => {\n    callbacksRef.current.push(cb);\n    pendingRef.current = true;\n  }, []);\n\n  return nextTick;\n}\n"
+    "import { useEffect, useLayoutEffect, useRef, useCallback } from \"react\";\n\nexport type NextTickCallback = () => void | Promise<void>;\n\nexport default function useNextTick(\n  useEffectHook: typeof useEffect | typeof useLayoutEffect = useEffect\n): (cb: NextTickCallback) => void {\n  const callbacksRef = useRef<NextTickCallback[]>([]);\n  const pendingRef = useRef(false);\n\n  useEffectHook(() => {\n    if (!pendingRef.current) return;\n\n    pendingRef.current = false;\n    const pending = callbacksRef.current;\n    callbacksRef.current = [];\n    setTimeout(() => {\n      for (const cb of pending) {\n        cb();\n      }\n    }, 0);\n  });\n\n  const nextTick = useCallback((cb: NextTickCallback) => {\n    callbacksRef.current.push(cb);\n    pendingRef.current = true;\n  }, []);\n\n  return nextTick;\n}\n"
   ],
-  "mappings": "AAAA,oBAAS,YAAW,iBAAQ,cAI5B,SAAwB,CAAW,EAAmC,CACpE,IAAM,EAAe,EAA2B,CAAC,CAAC,EAC5C,EAAa,EAAO,EAAK,EAoB/B,OAlBA,EAAU,IAAM,CACd,GAAI,CAAC,EAAW,QAAS,OAEzB,EAAW,QAAU,GACrB,IAAM,EAAU,EAAa,QAC7B,EAAa,QAAU,CAAC,EACxB,WAAW,IAAM,CACf,QAAW,KAAM,EACf,EAAG,GAEJ,CAAC,EACL,EAEgB,EAAY,CAAC,IAAyB,CACrD,EAAa,QAAQ,KAAK,CAAE,EAC5B,EAAW,QAAU,IACpB,CAAC,CAAC",
-  "debugId": "3B7FF0A1E8F2680564756E2164756E21",
+  "mappings": "AAAA,oBAAS,YAA4B,iBAAQ,cAI7C,SAAwB,CAAW,CACjC,EAA2D,EAC3B,CAChC,IAAM,EAAe,EAA2B,CAAC,CAAC,EAC5C,EAAa,EAAO,EAAK,EAoB/B,OAlBA,EAAc,IAAM,CAClB,GAAI,CAAC,EAAW,QAAS,OAEzB,EAAW,QAAU,GACrB,IAAM,EAAU,EAAa,QAC7B,EAAa,QAAU,CAAC,EACxB,WAAW,IAAM,CACf,QAAW,KAAM,EACf,EAAG,GAEJ,CAAC,EACL,EAEgB,EAAY,CAAC,IAAyB,CACrD,EAAa,QAAQ,KAAK,CAAE,EAC5B,EAAW,QAAU,IACpB,CAAC,CAAC",
+  "debugId": "0A16B9BA1C04CDB964756E2164756E21",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-next-tick",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "A React hook for running callbacks after the DOM or native views have updated.",
   "repository": "suhaotian/use-next-tick",
   "bugs": "https://github.com/suhaotian/use-next-tick/issues",