@usefy/use-throttle-callback 0.0.7 → 0.0.8

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/useThrottleCallback.ts"],"sourcesContent":["export {\r\n  useThrottleCallback,\r\n  type UseThrottleCallbackOptions,\r\n  type ThrottledFunction,\r\n} from \"./useThrottleCallback\";\r\n","import {\r\n  useDebounceCallback,\r\n  type DebouncedFunction,\r\n} from \"@usefy/use-debounce-callback\";\r\n\r\n/**\r\n * Options for useThrottleCallback hook\r\n */\r\nexport interface UseThrottleCallbackOptions {\r\n  /**\r\n   * Whether to invoke on the leading edge\r\n   * @default true\r\n   */\r\n  leading?: boolean;\r\n  /**\r\n   * Whether to invoke on the trailing edge\r\n   * @default true\r\n   */\r\n  trailing?: boolean;\r\n}\r\n\r\n/**\r\n * Throttled function interface with control methods\r\n */\r\nexport type ThrottledFunction<T extends (...args: any[]) => any> =\r\n  DebouncedFunction<T>;\r\n\r\n/**\r\n * Creates a throttled version of the provided callback function.\r\n * The throttled function limits invocations to at most once per specified interval.\r\n * This is implemented using useDebounceCallback with maxWait set to the interval.\r\n *\r\n * @template T - The type of the callback function\r\n * @param callback - The function to throttle\r\n * @param delay - The interval in milliseconds (default: 500ms)\r\n * @param options - Additional options for controlling throttle behavior\r\n * @returns A throttled version of the callback with cancel, flush, and pending methods\r\n *\r\n * @example\r\n * ```tsx\r\n * function ScrollTracker() {\r\n *   const throttledScroll = useThrottleCallback(\r\n *     () => {\r\n *       console.log('Scroll position:', window.scrollY);\r\n *     },\r\n *     100\r\n *   );\r\n *\r\n *   useEffect(() => {\r\n *     window.addEventListener('scroll', throttledScroll);\r\n *     return () => {\r\n *       throttledScroll.cancel();\r\n *       window.removeEventListener('scroll', throttledScroll);\r\n *     };\r\n *   }, [throttledScroll]);\r\n *\r\n *   return <div>Scroll to see throttled logs</div>;\r\n * }\r\n * ```\r\n *\r\n * @example\r\n * ```tsx\r\n * // With leading edge only\r\n * const throttledFn = useThrottleCallback(callback, 300, { leading: true, trailing: false });\r\n * ```\r\n *\r\n * @example\r\n * ```tsx\r\n * // With trailing edge only\r\n * const throttledFn = useThrottleCallback(callback, 300, { leading: false, trailing: true });\r\n *\r\n * // Cancel pending invocation\r\n * throttledFn.cancel();\r\n *\r\n * // Immediately invoke pending invocation\r\n * throttledFn.flush();\r\n *\r\n * // Check if there's a pending invocation\r\n * if (throttledFn.pending()) {\r\n *   console.log('There is a pending call');\r\n * }\r\n * ```\r\n */\r\nexport function useThrottleCallback<T extends (...args: any[]) => any>(\r\n  callback: T,\r\n  delay: number = 500,\r\n  options: UseThrottleCallbackOptions = {}\r\n): ThrottledFunction<T> {\r\n  const { leading = true, trailing = true } = options;\r\n\r\n  // Throttle is implemented using debounce with maxWait set to delay\r\n  return useDebounceCallback(callback, delay, {\r\n    leading,\r\n    maxWait: delay,\r\n    trailing,\r\n  });\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mCAGO;AAgFA,SAAS,oBACd,UACA,QAAgB,KAChB,UAAsC,CAAC,GACjB;AACtB,QAAM,EAAE,UAAU,MAAM,WAAW,KAAK,IAAI;AAG5C,aAAO,kDAAoB,UAAU,OAAO;AAAA,IAC1C;AAAA,IACA,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AACH;","names":[]}
+{"version":3,"sources":["../src/index.ts","../src/useThrottleCallback.ts"],"sourcesContent":["export {\n  useThrottleCallback,\n  type UseThrottleCallbackOptions,\n  type ThrottledFunction,\n} from \"./useThrottleCallback\";\n","import {\n  useDebounceCallback,\n  type DebouncedFunction,\n} from \"@usefy/use-debounce-callback\";\n\n/**\n * Options for useThrottleCallback hook\n */\nexport interface UseThrottleCallbackOptions {\n  /**\n   * Whether to invoke on the leading edge\n   * @default true\n   */\n  leading?: boolean;\n  /**\n   * Whether to invoke on the trailing edge\n   * @default true\n   */\n  trailing?: boolean;\n}\n\n/**\n * Throttled function interface with control methods\n */\nexport type ThrottledFunction<T extends (...args: any[]) => any> =\n  DebouncedFunction<T>;\n\n/**\n * Creates a throttled version of the provided callback function.\n * The throttled function limits invocations to at most once per specified interval.\n * This is implemented using useDebounceCallback with maxWait set to the interval.\n *\n * @template T - The type of the callback function\n * @param callback - The function to throttle\n * @param delay - The interval in milliseconds (default: 500ms)\n * @param options - Additional options for controlling throttle behavior\n * @returns A throttled version of the callback with cancel, flush, and pending methods\n *\n * @example\n * ```tsx\n * function ScrollTracker() {\n *   const throttledScroll = useThrottleCallback(\n *     () => {\n *       console.log('Scroll position:', window.scrollY);\n *     },\n *     100\n *   );\n *\n *   useEffect(() => {\n *     window.addEventListener('scroll', throttledScroll);\n *     return () => {\n *       throttledScroll.cancel();\n *       window.removeEventListener('scroll', throttledScroll);\n *     };\n *   }, [throttledScroll]);\n *\n *   return <div>Scroll to see throttled logs</div>;\n * }\n * ```\n *\n * @example\n * ```tsx\n * // With leading edge only\n * const throttledFn = useThrottleCallback(callback, 300, { leading: true, trailing: false });\n * ```\n *\n * @example\n * ```tsx\n * // With trailing edge only\n * const throttledFn = useThrottleCallback(callback, 300, { leading: false, trailing: true });\n *\n * // Cancel pending invocation\n * throttledFn.cancel();\n *\n * // Immediately invoke pending invocation\n * throttledFn.flush();\n *\n * // Check if there's a pending invocation\n * if (throttledFn.pending()) {\n *   console.log('There is a pending call');\n * }\n * ```\n */\nexport function useThrottleCallback<T extends (...args: any[]) => any>(\n  callback: T,\n  delay: number = 500,\n  options: UseThrottleCallbackOptions = {}\n): ThrottledFunction<T> {\n  const { leading = true, trailing = true } = options;\n\n  // Throttle is implemented using debounce with maxWait set to delay\n  return useDebounceCallback(callback, delay, {\n    leading,\n    maxWait: delay,\n    trailing,\n  });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mCAGO;AAgFA,SAAS,oBACd,UACA,QAAgB,KAChB,UAAsC,CAAC,GACjB;AACtB,QAAM,EAAE,UAAU,MAAM,WAAW,KAAK,IAAI;AAG5C,aAAO,kDAAoB,UAAU,OAAO;AAAA,IAC1C;AAAA,IACA,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AACH;","names":[]}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/useThrottleCallback.ts"],"sourcesContent":["import {\r\n  useDebounceCallback,\r\n  type DebouncedFunction,\r\n} from \"@usefy/use-debounce-callback\";\r\n\r\n/**\r\n * Options for useThrottleCallback hook\r\n */\r\nexport interface UseThrottleCallbackOptions {\r\n  /**\r\n   * Whether to invoke on the leading edge\r\n   * @default true\r\n   */\r\n  leading?: boolean;\r\n  /**\r\n   * Whether to invoke on the trailing edge\r\n   * @default true\r\n   */\r\n  trailing?: boolean;\r\n}\r\n\r\n/**\r\n * Throttled function interface with control methods\r\n */\r\nexport type ThrottledFunction<T extends (...args: any[]) => any> =\r\n  DebouncedFunction<T>;\r\n\r\n/**\r\n * Creates a throttled version of the provided callback function.\r\n * The throttled function limits invocations to at most once per specified interval.\r\n * This is implemented using useDebounceCallback with maxWait set to the interval.\r\n *\r\n * @template T - The type of the callback function\r\n * @param callback - The function to throttle\r\n * @param delay - The interval in milliseconds (default: 500ms)\r\n * @param options - Additional options for controlling throttle behavior\r\n * @returns A throttled version of the callback with cancel, flush, and pending methods\r\n *\r\n * @example\r\n * ```tsx\r\n * function ScrollTracker() {\r\n *   const throttledScroll = useThrottleCallback(\r\n *     () => {\r\n *       console.log('Scroll position:', window.scrollY);\r\n *     },\r\n *     100\r\n *   );\r\n *\r\n *   useEffect(() => {\r\n *     window.addEventListener('scroll', throttledScroll);\r\n *     return () => {\r\n *       throttledScroll.cancel();\r\n *       window.removeEventListener('scroll', throttledScroll);\r\n *     };\r\n *   }, [throttledScroll]);\r\n *\r\n *   return <div>Scroll to see throttled logs</div>;\r\n * }\r\n * ```\r\n *\r\n * @example\r\n * ```tsx\r\n * // With leading edge only\r\n * const throttledFn = useThrottleCallback(callback, 300, { leading: true, trailing: false });\r\n * ```\r\n *\r\n * @example\r\n * ```tsx\r\n * // With trailing edge only\r\n * const throttledFn = useThrottleCallback(callback, 300, { leading: false, trailing: true });\r\n *\r\n * // Cancel pending invocation\r\n * throttledFn.cancel();\r\n *\r\n * // Immediately invoke pending invocation\r\n * throttledFn.flush();\r\n *\r\n * // Check if there's a pending invocation\r\n * if (throttledFn.pending()) {\r\n *   console.log('There is a pending call');\r\n * }\r\n * ```\r\n */\r\nexport function useThrottleCallback<T extends (...args: any[]) => any>(\r\n  callback: T,\r\n  delay: number = 500,\r\n  options: UseThrottleCallbackOptions = {}\r\n): ThrottledFunction<T> {\r\n  const { leading = true, trailing = true } = options;\r\n\r\n  // Throttle is implemented using debounce with maxWait set to delay\r\n  return useDebounceCallback(callback, delay, {\r\n    leading,\r\n    maxWait: delay,\r\n    trailing,\r\n  });\r\n}\r\n"],"mappings":";AAAA;AAAA,EACE;AAAA,OAEK;AAgFA,SAAS,oBACd,UACA,QAAgB,KAChB,UAAsC,CAAC,GACjB;AACtB,QAAM,EAAE,UAAU,MAAM,WAAW,KAAK,IAAI;AAG5C,SAAO,oBAAoB,UAAU,OAAO;AAAA,IAC1C;AAAA,IACA,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AACH;","names":[]}
+{"version":3,"sources":["../src/useThrottleCallback.ts"],"sourcesContent":["import {\n  useDebounceCallback,\n  type DebouncedFunction,\n} from \"@usefy/use-debounce-callback\";\n\n/**\n * Options for useThrottleCallback hook\n */\nexport interface UseThrottleCallbackOptions {\n  /**\n   * Whether to invoke on the leading edge\n   * @default true\n   */\n  leading?: boolean;\n  /**\n   * Whether to invoke on the trailing edge\n   * @default true\n   */\n  trailing?: boolean;\n}\n\n/**\n * Throttled function interface with control methods\n */\nexport type ThrottledFunction<T extends (...args: any[]) => any> =\n  DebouncedFunction<T>;\n\n/**\n * Creates a throttled version of the provided callback function.\n * The throttled function limits invocations to at most once per specified interval.\n * This is implemented using useDebounceCallback with maxWait set to the interval.\n *\n * @template T - The type of the callback function\n * @param callback - The function to throttle\n * @param delay - The interval in milliseconds (default: 500ms)\n * @param options - Additional options for controlling throttle behavior\n * @returns A throttled version of the callback with cancel, flush, and pending methods\n *\n * @example\n * ```tsx\n * function ScrollTracker() {\n *   const throttledScroll = useThrottleCallback(\n *     () => {\n *       console.log('Scroll position:', window.scrollY);\n *     },\n *     100\n *   );\n *\n *   useEffect(() => {\n *     window.addEventListener('scroll', throttledScroll);\n *     return () => {\n *       throttledScroll.cancel();\n *       window.removeEventListener('scroll', throttledScroll);\n *     };\n *   }, [throttledScroll]);\n *\n *   return <div>Scroll to see throttled logs</div>;\n * }\n * ```\n *\n * @example\n * ```tsx\n * // With leading edge only\n * const throttledFn = useThrottleCallback(callback, 300, { leading: true, trailing: false });\n * ```\n *\n * @example\n * ```tsx\n * // With trailing edge only\n * const throttledFn = useThrottleCallback(callback, 300, { leading: false, trailing: true });\n *\n * // Cancel pending invocation\n * throttledFn.cancel();\n *\n * // Immediately invoke pending invocation\n * throttledFn.flush();\n *\n * // Check if there's a pending invocation\n * if (throttledFn.pending()) {\n *   console.log('There is a pending call');\n * }\n * ```\n */\nexport function useThrottleCallback<T extends (...args: any[]) => any>(\n  callback: T,\n  delay: number = 500,\n  options: UseThrottleCallbackOptions = {}\n): ThrottledFunction<T> {\n  const { leading = true, trailing = true } = options;\n\n  // Throttle is implemented using debounce with maxWait set to delay\n  return useDebounceCallback(callback, delay, {\n    leading,\n    maxWait: delay,\n    trailing,\n  });\n}\n"],"mappings":";AAAA;AAAA,EACE;AAAA,OAEK;AAgFA,SAAS,oBACd,UACA,QAAgB,KAChB,UAAsC,CAAC,GACjB;AACtB,QAAM,EAAE,UAAU,MAAM,WAAW,KAAK,IAAI;AAG5C,SAAO,oBAAoB,UAAU,OAAO;AAAA,IAC1C;AAAA,IACA,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AACH;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usefy/use-throttle-callback",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "A React hook for throttling callback functions",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -17,7 +17,7 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@usefy/use-debounce-callback": "0.0.7"
+    "@usefy/use-debounce-callback": "0.0.8"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0"