@oneplatformdev/hooks 0.1.0-15 → 0.1.0-150

package/useBoolean/useBoolean.d.ts

@@ -0,0 +1,29 @@
+import { Dispatch, SetStateAction } from 'react';
+/** The useBoolean return type. */
+type UseBooleanReturn = {
+    /** The current boolean state value. */
+    value: boolean;
+    /** Function to set the boolean state directly. */
+    setValue: Dispatch<SetStateAction<boolean>>;
+    /** Function to set the boolean state to `true`. */
+    setTrue: () => void;
+    /** Function to set the boolean state to `false`. */
+    setFalse: () => void;
+    /** Function to toggle the boolean state. */
+    toggle: () => void;
+};
+/**
+ * Custom hook that handles boolean state with useful utility functions.
+ * @param {boolean} [defaultValue] - The initial value for the boolean state (default is `false`).
+ * @returns {UseBooleanReturn} An object containing the boolean state value and utility functions to manipulate the state.
+ * @throws Will throw an error if `defaultValue` is an invalid boolean value.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-boolean)
+ * @example
+ * ```tsx
+ * const { value, setTrue, setFalse, toggle } = useBoolean(true);
+ * ```
+ */
+export declare function useBoolean(defaultValue?: boolean): UseBooleanReturn;
+export {};
+//# sourceMappingURL=useBoolean.d.ts.map

package/useBoolean/useBoolean.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useBoolean.d.ts","sourceRoot":"","sources":["../../src/useBoolean/useBoolean.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAErD,kCAAkC;AAClC,KAAK,gBAAgB,GAAG;IACtB,uCAAuC;IACvC,KAAK,EAAE,OAAO,CAAA;IACd,kDAAkD;IAClD,QAAQ,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAA;IAC3C,mDAAmD;IACnD,OAAO,EAAE,MAAM,IAAI,CAAA;IACnB,oDAAoD;IACpD,QAAQ,EAAE,MAAM,IAAI,CAAA;IACpB,4CAA4C;IAC5C,MAAM,EAAE,MAAM,IAAI,CAAA;CACnB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,YAAY,UAAQ,GAAG,gBAAgB,CAmBjE"}

package/useBoolean/useBoolean.js

@@ -0,0 +1,16 @@
+import { useState as n, useCallback as t } from "react";
+function c(o = !1) {
+  if (typeof o != "boolean")
+    throw new Error("defaultValue must be `true` or `false`");
+  const [s, e] = n(o), r = t(() => {
+    e(!0);
+  }, []), a = t(() => {
+    e(!1);
+  }, []), l = t(() => {
+    e((u) => !u);
+  }, []);
+  return { value: s, setValue: e, setTrue: r, setFalse: a, toggle: l };
+}
+export {
+  c as useBoolean
+};

package/useClickAnyWhere/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useClickAnyWhere';
+//# sourceMappingURL=index.d.ts.map

package/useClickAnyWhere/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useClickAnyWhere/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA"}

package/useClickAnyWhere/index.js

@@ -0,0 +1,4 @@
+import { useClickAnyWhere as o } from "./useClickAnyWhere.js";
+export {
+  o as useClickAnyWhere
+};

package/useClickAnyWhere/useClickAnyWhere.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Custom hook that handles click events anywhere on the document.
+ * @param {Function} handler - The function to be called when a click event is detected anywhere on the document.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-click-any-where)
+ * @example
+ * ```tsx
+ * const handleClick = (event) => {
+ *   console.log('Document clicked!', event);
+ * };
+ *
+ * // Attach click event handler to document
+ * useClickAnywhere(handleClick);
+ * ```
+ */
+export declare function useClickAnyWhere(handler: (event: MouseEvent) => void): void;
+//# sourceMappingURL=useClickAnyWhere.d.ts.map

package/useClickAnyWhere/useClickAnyWhere.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useClickAnyWhere.d.ts","sourceRoot":"","sources":["../../src/useClickAnyWhere/useClickAnyWhere.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,QAIpE"}

package/useClickAnyWhere/useClickAnyWhere.js

@@ -0,0 +1,9 @@
+import { useEventListener as n } from "../useEventListener/useEventListener.js";
+function t(e) {
+  n("click", (i) => {
+    e(i);
+  });
+}
+export {
+  t as useClickAnyWhere
+};

package/useCopyToClipboard/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useCopyToClipboard';
+//# sourceMappingURL=index.d.ts.map

package/useCopyToClipboard/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useCopyToClipboard/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA"}

package/useCopyToClipboard/index.js

@@ -0,0 +1,4 @@
+import { useCopyToClipboard as r } from "./useCopyToClipboard.js";
+export {
+  r as useCopyToClipboard
+};

package/useCopyToClipboard/useCopyToClipboard.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The copied text as `string` or `null` if nothing has been copied yet.
+ */
+type CopiedValue = string | null;
+/**
+ * Function to copy text to the clipboard.
+ * @param text - The text to copy to the clipboard.
+ * @returns {Promise<boolean>} A promise that resolves to `true` if the text was copied successfully, or `false` otherwise.
+ */
+type CopyFn = (text: string) => Promise<boolean>;
+/**
+ * Custom hook that copies text to the clipboard using the [`Clipboard API`](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API).
+ * @returns {[CopiedValue, CopyFn]} An tuple containing the copied text and a function to copy text to the clipboard.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-copy-to-clipboard)
+ * @example
+ * ```tsx
+ * const [copiedText, copyToClipboard] = useCopyToClipboard();
+ * const textToCopy = 'Hello, world!';
+ *
+ * // Attempt to copy text to the clipboard
+ * copyToClipboard(textToCopy)
+ *   .then(success => {
+ *     if (success) {
+ *       console.log(`Text "${textToCopy}" copied to clipboard successfully.`);
+ *     } else {
+ *       console.error('Failed to copy text to clipboard.');
+ *     }
+ *   });
+ * ```
+ */
+export declare function useCopyToClipboard(): [CopiedValue, CopyFn];
+export {};
+//# sourceMappingURL=useCopyToClipboard.d.ts.map

package/useCopyToClipboard/useCopyToClipboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCopyToClipboard.d.ts","sourceRoot":"","sources":["../../src/useCopyToClipboard/useCopyToClipboard.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,KAAK,WAAW,GAAG,MAAM,GAAG,IAAI,CAAA;AAEhC;;;;GAIG;AACH,KAAK,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;AAEhD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,kBAAkB,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAsB1D"}

package/useCopyToClipboard/useCopyToClipboard.js

@@ -0,0 +1,16 @@
+import { useState as n, useCallback as l } from "react";
+function c() {
+  const [e, r] = n(null), t = l(async (o) => {
+    if (!navigator?.clipboard)
+      return console.warn("Clipboard not supported"), !1;
+    try {
+      return await navigator.clipboard.writeText(o), r(o), !0;
+    } catch (a) {
+      return console.warn("Copy failed", a), r(null), !1;
+    }
+  }, []);
+  return [e, t];
+}
+export {
+  c as useCopyToClipboard
+};

package/useCountdown/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useCountdown';
+//# sourceMappingURL=index.d.ts.map

package/useCountdown/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useCountdown/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA"}

package/useCountdown/index.js

@@ -0,0 +1,4 @@
+import { useCountdown as n } from "./useCountdown.js";
+export {
+  n as useCountdown
+};

package/useCountdown/useCountdown.d.ts

@@ -0,0 +1,47 @@
+/** The countdown's options. */
+type CountdownOptions = {
+    /** The countdown's starting number, initial value of the returned number. */
+    countStart: number;
+    /**
+     * The countdown's interval, in milliseconds.
+     * @default 1000
+     */
+    intervalMs?: number;
+    /**
+     * True if the countdown is increment.
+     * @default false
+     */
+    isIncrement?: boolean;
+    /**
+     * The countdown's stopping number. Pass `-Infinity` to decrease forever.
+     * @default 0
+     */
+    countStop?: number;
+};
+/** The countdown's controllers. */
+type CountdownControllers = {
+    /** Start the countdown. */
+    startCountdown: () => void;
+    /** Stop the countdown. */
+    stopCountdown: () => void;
+    /** Reset the countdown. */
+    resetCountdown: () => void;
+};
+/**
+ * Custom hook that manages countdown.
+ * @param {CountdownOptions} countdownOptions - The countdown's options.
+ * @returns {[number, CountdownControllers]} An array containing the countdown's count and its controllers.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-countdown)
+ * @example
+ * ```tsx
+ * const [counter, { start, stop, reset }] = useCountdown({
+ *   countStart: 10,
+ *   intervalMs: 1000,
+ *   isIncrement: false,
+ * });
+ * ```
+ */
+export declare function useCountdown({ countStart, countStop, intervalMs, isIncrement, }: CountdownOptions): [number, CountdownControllers];
+export {};
+//# sourceMappingURL=useCountdown.d.ts.map

package/useCountdown/useCountdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCountdown.d.ts","sourceRoot":"","sources":["../../src/useCountdown/useCountdown.ts"],"names":[],"mappings":"AAMA,+BAA+B;AAC/B,KAAK,gBAAgB,GAAG;IACtB,6EAA6E;IAC7E,UAAU,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,mCAAmC;AACnC,KAAK,oBAAoB,GAAG;IAC1B,2BAA2B;IAC3B,cAAc,EAAE,MAAM,IAAI,CAAA;IAC1B,0BAA0B;IAC1B,aAAa,EAAE,MAAM,IAAI,CAAA;IACzB,2BAA2B;IAC3B,cAAc,EAAE,MAAM,IAAI,CAAA;CAC3B,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,EAC3B,UAAU,EACV,SAAa,EACb,UAAiB,EACjB,WAAmB,GACpB,EAAE,gBAAgB,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,CA0CnD"}

package/useCountdown/useCountdown.js

@@ -0,0 +1,33 @@
+import { useCallback as l } from "react";
+import { useBoolean as d } from "../useBoolean/useBoolean.js";
+import { useCounter as w } from "../useCounter/useCounter.js";
+import { useInterval as p } from "../useInterval/useInterval.js";
+function x({
+  countStart: a,
+  countStop: n = 0,
+  intervalMs: c = 1e3,
+  isIncrement: t = !1
+}) {
+  const {
+    count: o,
+    increment: r,
+    decrement: s,
+    reset: u
+  } = w(a), {
+    value: f,
+    setTrue: i,
+    setFalse: e
+  } = d(!1), m = l(() => {
+    e(), u();
+  }, [e, u]), C = l(() => {
+    if (o === n) {
+      e();
+      return;
+    }
+    t ? r() : s();
+  }, [o, n, s, r, t, e]);
+  return p(C, f ? c : null), [o, { startCountdown: i, stopCountdown: e, resetCountdown: m }];
+}
+export {
+  x as useCountdown
+};

package/useCounter/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useCounter';
+//# sourceMappingURL=index.d.ts.map

package/useCounter/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useCounter/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/useCounter/index.js

@@ -0,0 +1,4 @@
+import { useCounter as r } from "./useCounter.js";
+export {
+  r as useCounter
+};

package/useCounter/useCounter.d.ts

@@ -0,0 +1,28 @@
+import { Dispatch, SetStateAction } from 'react';
+/** The hook return type. */
+type UseCounterReturn = {
+    /** The current count value. */
+    count: number;
+    /** Function to increment the counter by 1. */
+    increment: () => void;
+    /** Function to decrement the counter by 1. */
+    decrement: () => void;
+    /** Function to reset the counter to its initial value. */
+    reset: () => void;
+    /** Function to set a specific value to the counter. */
+    setCount: Dispatch<SetStateAction<number>>;
+};
+/**
+ * Custom hook that manages a counter with increment, decrement, reset, and setCount functionalities.
+ * @param {number} [initialValue] - The initial value for the counter.
+ * @returns {UseCounterReturn} An object containing the current count and functions to interact with the counter.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-counter)
+ * @example
+ * ```tsx
+ * const { count, increment, decrement, reset, setCount } = useCounter(5);
+ * ```
+ */
+export declare function useCounter(initialValue?: number): UseCounterReturn;
+export {};
+//# sourceMappingURL=useCounter.d.ts.map

package/useCounter/useCounter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCounter.d.ts","sourceRoot":"","sources":["../../src/useCounter/useCounter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAErD,4BAA4B;AAC5B,KAAK,gBAAgB,GAAG;IACtB,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,8CAA8C;IAC9C,SAAS,EAAE,MAAM,IAAI,CAAA;IACrB,8CAA8C;IAC9C,SAAS,EAAE,MAAM,IAAI,CAAA;IACrB,0DAA0D;IAC1D,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,uDAAuD;IACvD,QAAQ,EAAE,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAA;CAC3C,CAAA;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAsBlE"}

package/useCounter/useCounter.js

@@ -0,0 +1,20 @@
+import { useState as m, useCallback as o } from "react";
+function f(e) {
+  const [c, t] = m(e ?? 0), r = o(() => {
+    t((n) => n + 1);
+  }, []), s = o(() => {
+    t((n) => n - 1);
+  }, []), u = o(() => {
+    t(e ?? 0);
+  }, [e]);
+  return {
+    count: c,
+    increment: r,
+    decrement: s,
+    reset: u,
+    setCount: t
+  };
+}
+export {
+  f as useCounter
+};

package/useDarkMode/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useDarkMode';
+//# sourceMappingURL=index.d.ts.map

package/useDarkMode/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useDarkMode/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA"}

package/useDarkMode/index.js

@@ -0,0 +1,4 @@
+import { useDarkMode as r } from "./useDarkMode.js";
+export {
+  r as useDarkMode
+};

package/useDarkMode/useDarkMode.d.ts

@@ -0,0 +1,46 @@
+/** The hook options. */
+type DarkModeOptions = {
+    /**
+     * The initial value of the dark mode.
+     * @default false
+     */
+    defaultValue?: boolean;
+    /**
+     * The key to use in the local storage.
+     * @default 'usehooks-ts-dark-mode'
+     */
+    localStorageKey?: string;
+    /**
+     * If `true` (default), the hook will initialize reading `localStorage`.
+     * In SSR, you should set it to `false`, returning the `defaultValue` or `false` initially.
+     * @default true
+     */
+    initializeWithValue?: boolean;
+};
+/** The hook return type. */
+type DarkModeReturn = {
+    /** The current state of the dark mode. */
+    isDarkMode: boolean;
+    /** Function to toggle the dark mode. */
+    toggle: () => void;
+    /** Function to enable the dark mode. */
+    enable: () => void;
+    /** Function to disable the dark mode. */
+    disable: () => void;
+    /** Function to set a specific value to the dark mode. */
+    set: (value: boolean) => void;
+};
+/**
+ * Custom hook that returns the current state of the dark mode.
+ * @param {?DarkModeOptions} [options] - The initial value of the dark mode, default `false`.
+ * @returns {DarkModeReturn} An object containing the dark mode's state and its controllers.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-dark-mode)
+ * @example
+ * ```tsx
+ * const { isDarkMode, toggle, enable, disable, set } = useDarkMode({ defaultValue: true });
+ * ```
+ */
+export declare function useDarkMode(options?: DarkModeOptions): DarkModeReturn;
+export {};
+//# sourceMappingURL=useDarkMode.d.ts.map

package/useDarkMode/useDarkMode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDarkMode.d.ts","sourceRoot":"","sources":["../../src/useDarkMode/useDarkMode.ts"],"names":[],"mappings":"AAOA,wBAAwB;AACxB,KAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B,CAAA;AAED,4BAA4B;AAC5B,KAAK,cAAc,GAAG;IACpB,0CAA0C;IAC1C,UAAU,EAAE,OAAO,CAAA;IACnB,wCAAwC;IACxC,MAAM,EAAE,MAAM,IAAI,CAAA;IAClB,wCAAwC;IACxC,MAAM,EAAE,MAAM,IAAI,CAAA;IAClB,yCAAyC;IACzC,OAAO,EAAE,MAAM,IAAI,CAAA;IACnB,yDAAyD;IACzD,GAAG,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;CAC9B,CAAA;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,OAAO,GAAE,eAAoB,GAAG,cAAc,CAuCzE"}

package/useDarkMode/useDarkMode.js

@@ -0,0 +1,38 @@
+import { useIsomorphicLayoutEffect as l } from "../useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js";
+import { useLocalStorage as c } from "../useLocalStorage/useLocalStorage.js";
+import { useMediaQuery as f } from "../useMediaQuery/useMediaQuery.js";
+const n = "(prefers-color-scheme: dark)", d = "usehooks-ts-dark-mode";
+function E(i = {}) {
+  const {
+    defaultValue: t,
+    localStorageKey: u = d,
+    initializeWithValue: s = !0
+  } = i, o = f(n, {
+    initializeWithValue: s,
+    defaultValue: t
+  }), [a, e] = c(
+    u,
+    t ?? o ?? !1,
+    { initializeWithValue: s }
+  );
+  return l(() => {
+    o !== a && e(o);
+  }, [o]), {
+    isDarkMode: a,
+    toggle: () => {
+      e((r) => !r);
+    },
+    enable: () => {
+      e(!0);
+    },
+    disable: () => {
+      e(!1);
+    },
+    set: (r) => {
+      e(r);
+    }
+  };
+}
+export {
+  E as useDarkMode
+};

package/useDebounceCallback/index.d.ts

@@ -0,0 +1,3 @@
+export * from './useDebounceCallback';
+export { useDebounceCallback as default } from './useDebounceCallback';
+//# sourceMappingURL=index.d.ts.map

package/useDebounceCallback/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useDebounceCallback/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,OAAO,EAAC,mBAAmB,IAAI,OAAO,EAAE,MAAM,uBAAuB,CAAA"}

package/useDebounceCallback/index.js

@@ -0,0 +1,5 @@
+import { useDebounceCallback as l, useDebounceCallback as u } from "./useDebounceCallback.js";
+export {
+  l as default,
+  u as useDebounceCallback
+};

package/useDebounceCallback/useDebounceCallback.d.ts

@@ -0,0 +1,62 @@
+/** Configuration options for controlling the behavior of the debounced function. */
+type DebounceOptions = {
+    /**
+     * Determines whether the function should be invoked on the leading edge of the timeout.
+     * @default false
+     */
+    leading?: boolean;
+    /**
+     * Determines whether the function should be invoked on the trailing edge of the timeout.
+     * @default false
+     */
+    trailing?: boolean;
+    /**
+     * The maximum time the specified function is allowed to be delayed before it is invoked.
+     */
+    maxWait?: number;
+};
+/** Functions to manage a debounced callback. */
+type ControlFunctions = {
+    /** Cancels pending function invocations. */
+    cancel: () => void;
+    /** Immediately invokes pending function invocations. */
+    flush: () => void;
+    /**
+     * Checks if there are any pending function invocations.
+     * @returns `true` if there are pending invocations, otherwise `false`.
+     */
+    isPending: () => boolean;
+};
+/**
+ * Represents the state and control functions of a debounced callback.
+ * Subsequent calls to the debounced function return the result of the last invocation.
+ * Note: If there are no previous invocations, the result will be undefined.
+ * Ensure proper handling in your code.
+ */
+export type DebouncedState<T extends (...args: any) => ReturnType<T>> = ((...args: Parameters<T>) => ReturnType<T> | undefined) & ControlFunctions;
+/**
+ * Custom hook that creates a debounced version of a callback function.
+ * @template T - Type of the original callback function.
+ * @param {T} func - The callback function to be debounced.
+ * @param {number} delay - The delay in milliseconds before the callback is invoked (default is `500` milliseconds).
+ * @param {DebounceOptions} [options] - Options to control the behavior of the debounced function.
+ * @returns {DebouncedState<T>} A debounced version of the original callback along with control functions.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-debounce-callback)
+ * @example
+ * ```tsx
+ * const debouncedCallback = useDebounceCallback(
+ *   (searchTerm) => {
+ *     // Perform search after user stops typing for 500 milliseconds
+ *     searchApi(searchTerm);
+ *   },
+ *   500
+ * );
+ *
+ * // Later in the component
+ * debouncedCallback('react hooks'); // Will invoke the callback after 500 milliseconds of inactivity.
+ * ```
+ */
+export declare function useDebounceCallback<T extends (...args: any) => ReturnType<T>>(func: T, delay?: number, options?: DebounceOptions): DebouncedState<T>;
+export {};
+//# sourceMappingURL=useDebounceCallback.d.ts.map

package/useDebounceCallback/useDebounceCallback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDebounceCallback.d.ts","sourceRoot":"","sources":["../../src/useDebounceCallback/useDebounceCallback.ts"],"names":[],"mappings":"AAMA,oFAAoF;AACpF,KAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,gDAAgD;AAChD,KAAK,gBAAgB,GAAG;IACtB,4CAA4C;IAC5C,MAAM,EAAE,MAAM,IAAI,CAAA;IAClB,wDAAwD;IACxD,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB;;;OAGG;IACH,SAAS,EAAE,MAAM,OAAO,CAAA;CACzB,CAAA;AAED;;;;;GAKG;AAEH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CACvE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KACnB,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GAC7B,gBAAgB,CAAA;AAElB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,EAC3E,IAAI,EAAE,CAAC,EACP,KAAK,SAAM,EACX,OAAO,CAAC,EAAE,eAAe,GACxB,cAAc,CAAC,CAAC,CAAC,CAqCnB"}

package/useDebounceCallback/useDebounceCallback.js

@@ -0,0 +1,21 @@
+import { useRef as f, useMemo as b, useEffect as d } from "react";
+import o from "lodash.debounce";
+import { useUnmount as l } from "../useUnmount/useUnmount.js";
+function F(e, n = 500, r) {
+  const u = f(null);
+  l(() => {
+    u.current && u.current.cancel();
+  });
+  const s = b(() => {
+    const t = o(e, n, r), c = (...m) => t(...m);
+    return c.cancel = () => {
+      t.cancel();
+    }, c.isPending = () => !!u.current, c.flush = () => t.flush(), c;
+  }, [e, n, r]);
+  return d(() => {
+    u.current = o(e, n, r);
+  }, [e, n, r]), s;
+}
+export {
+  F as useDebounceCallback
+};

package/useDebounceValue/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useDebounceValue';
+//# sourceMappingURL=index.d.ts.map

package/useDebounceValue/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useDebounceValue/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA"}

package/useDebounceValue/index.js

@@ -0,0 +1,4 @@
+import { useDebounceValue as u } from "./useDebounceValue.js";
+export {
+  u as useDebounceValue
+};

package/useDebounceValue/useDebounceValue.d.ts

@@ -0,0 +1,40 @@
+import { DebouncedState } from '../useDebounceCallback';
+/**
+ * Hook options.
+ * @template T - The type of the value.
+ */
+type UseDebounceValueOptions<T> = {
+    /**
+     * Determines whether the function should be invoked on the leading edge of the timeout.
+     * @default false
+     */
+    leading?: boolean;
+    /**
+     * Determines whether the function should be invoked on the trailing edge of the timeout.
+     * @default false
+     */
+    trailing?: boolean;
+    /**
+     * The maximum time the specified function is allowed to be delayed before it is invoked.
+     */
+    maxWait?: number;
+    /** A function to determine if the value has changed. Defaults to a function that checks if the value is strictly equal to the previous value. */
+    equalityFn?: (left: T, right: T) => boolean;
+};
+/**
+ * Custom hook that returns a debounced version of the provided value, along with a function to update it.
+ * @template T - The type of the value.
+ * @param {T | (() => T)} initialValue - The value to be debounced.
+ * @param {number} delay - The delay in milliseconds before the value is updated (default is 500ms).
+ * @param {object} [options] - Optional configurations for the debouncing behavior.
+ * @returns {[T, DebouncedState<(value: T) => void>]} An array containing the debounced value and the function to update it.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-debounce-value)
+ * @example
+ * ```tsx
+ * const [debouncedValue, updateDebouncedValue] = useDebounceValue(inputValue, 500, { leading: true });
+ * ```
+ */
+export declare function useDebounceValue<T>(initialValue: T | (() => T), delay: number, options?: UseDebounceValueOptions<T>): [T, DebouncedState<(value: T) => void>];
+export {};
+//# sourceMappingURL=useDebounceValue.d.ts.map

package/useDebounceValue/useDebounceValue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDebounceValue.d.ts","sourceRoot":"","sources":["../../src/useDebounceValue/useDebounceValue.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAG5D;;;GAGG;AACH,KAAK,uBAAuB,CAAC,CAAC,IAAI;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iJAAiJ;IACjJ,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,OAAO,CAAA;CAC5C,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,YAAY,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAC3B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC,CAAC,GACnC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAoBzC"}

package/useDebounceValue/useDebounceValue.js

@@ -0,0 +1,13 @@
+import { useState as d, useRef as l } from "react";
+import { useDebounceCallback as p } from "../useDebounceCallback/useDebounceCallback.js";
+function V(u, c, n) {
+  const r = n?.equalityFn ?? ((f, b) => f === b), e = u instanceof Function ? u() : u, [s, a] = d(e), o = l(e), t = p(
+    a,
+    c,
+    n
+  );
+  return r(o.current, e) || (t(e), o.current = e), [s, t];
+}
+export {
+  V as useDebounceValue
+};

package/useDocumentTitle/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useDocumentTitle';
+//# sourceMappingURL=index.d.ts.map

package/useDocumentTitle/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useDocumentTitle/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA"}

package/useDocumentTitle/index.js

@@ -0,0 +1,4 @@
+import { useDocumentTitle as t } from "./useDocumentTitle.js";
+export {
+  t as useDocumentTitle
+};