@usefy/usefy 0.0.18 → 0.0.19

package/README.md

@@ -114,6 +114,7 @@ All packages require React 18 or 19:
 | [@usefy/use-copy-to-clipboard](https://www.npmjs.com/package/@usefy/use-copy-to-clipboard) | Clipboard copy with fallback support                    | [![npm](https://img.shields.io/npm/v/@usefy/use-copy-to-clipboard.svg?style=flat-square&color=007acc)](https://www.npmjs.com/package/@usefy/use-copy-to-clipboard) | ![88%](https://img.shields.io/badge/coverage-88%25-brightgreen?style=flat-square)   |
 | [@usefy/use-event-listener](https://www.npmjs.com/package/@usefy/use-event-listener)       | DOM event listener with auto cleanup                    | [![npm](https://img.shields.io/npm/v/@usefy/use-event-listener.svg?style=flat-square&color=007acc)](https://www.npmjs.com/package/@usefy/use-event-listener)       | ![96%](https://img.shields.io/badge/coverage-96%25-brightgreen?style=flat-square)   |
 | [@usefy/use-on-click-outside](https://www.npmjs.com/package/@usefy/use-on-click-outside)   | Outside click detection for modals/dropdowns            | [![npm](https://img.shields.io/npm/v/@usefy/use-on-click-outside.svg?style=flat-square&color=007acc)](https://www.npmjs.com/package/@usefy/use-on-click-outside)   | ![97%](https://img.shields.io/badge/coverage-97%25-brightgreen?style=flat-square)   |
+| [@usefy/use-timer](https://www.npmjs.com/package/@usefy/use-timer)                         | Countdown timer with drift compensation and formats     | [![npm](https://img.shields.io/npm/v/@usefy/use-timer.svg?style=flat-square&color=007acc)](https://www.npmjs.com/package/@usefy/use-timer)                         | ![84%](https://img.shields.io/badge/coverage-84%25-brightgreen?style=flat-square)   |
 
 ---
 
@@ -297,6 +298,36 @@ const throttledFn = useThrottleCallback(callback, 100);
 
 </details>
 
+<details>
+<summary><strong>useTimer</strong> — Countdown timer with accurate timing</summary>
+
+```tsx
+import { useTimer, ms } from "@usefy/use-timer";
+
+const timer = useTimer(ms.minutes(5), {
+  format: "MM:SS",
+  autoStart: false,
+  loop: false,
+  onComplete: () => console.log("Time's up!"),
+});
+
+// Controls
+timer.start();
+timer.pause();
+timer.reset();
+timer.addTime(ms.seconds(10));
+timer.subtractTime(ms.seconds(5));
+
+// State
+timer.formattedTime; // "05:00"
+timer.progress; // 0-100
+timer.isRunning; // boolean
+```
+
+Perfect for countdown timers, Pomodoro apps, kitchen timers, and time-based UIs with smart render optimization.
+
+</details>
+
 ### 💾 Storage
 
 <details>
@@ -442,6 +473,7 @@ All packages are comprehensively tested using Vitest to ensure reliability and s
 | use-copy-to-clipboard | 88%        | 79%      | 86%       | 88%   |
 | use-event-listener    | 96%        | 91%      | 100%      | 96%   |
 | use-on-click-outside  | 97%        | 93%      | 100%      | 97%   |
+| use-timer             | 84%        | 73%      | 94%       | 84%   |
 
 ---
 

package/dist/index.d.mts

@@ -10,3 +10,4 @@ export { InitialValue, UseLocalStorageOptions, UseLocalStorageReturn, useLocalSt
 export { InitialValue as SessionStorageInitialValue, UseSessionStorageOptions, UseSessionStorageReturn, useSessionStorage } from '@usefy/use-session-storage';
 export { ClickOutsideEvent, MouseEventType, OnClickOutsideHandler, RefTarget, TouchEventType, UseOnClickOutsideOptions, useOnClickOutside } from '@usefy/use-on-click-outside';
 export { EventTargetType, UseEventListenerOptions, useEventListener } from '@usefy/use-event-listener';
+export { TimeFormat, TimeUnit, UseTimerOptions, UseTimerReturn, useTimer } from '@usefy/use-timer';

package/dist/index.d.ts

@@ -10,3 +10,4 @@ export { InitialValue, UseLocalStorageOptions, UseLocalStorageReturn, useLocalSt
 export { InitialValue as SessionStorageInitialValue, UseSessionStorageOptions, UseSessionStorageReturn, useSessionStorage } from '@usefy/use-session-storage';
 export { ClickOutsideEvent, MouseEventType, OnClickOutsideHandler, RefTarget, TouchEventType, UseOnClickOutsideOptions, useOnClickOutside } from '@usefy/use-on-click-outside';
 export { EventTargetType, UseEventListenerOptions, useEventListener } from '@usefy/use-event-listener';
+export { TimeFormat, TimeUnit, UseTimerOptions, UseTimerReturn, useTimer } from '@usefy/use-timer';

package/dist/index.js

@@ -31,6 +31,7 @@ __export(index_exports, {
   useSessionStorage: () => import_use_session_storage.useSessionStorage,
   useThrottle: () => import_use_throttle.useThrottle,
   useThrottleCallback: () => import_use_throttle_callback.useThrottleCallback,
+  useTimer: () => import_use_timer.useTimer,
   useToggle: () => import_use_toggle.useToggle
 });
 module.exports = __toCommonJS(index_exports);
@@ -46,6 +47,7 @@ var import_use_local_storage = require("@usefy/use-local-storage");
 var import_use_session_storage = require("@usefy/use-session-storage");
 var import_use_on_click_outside = require("@usefy/use-on-click-outside");
 var import_use_event_listener = require("@usefy/use-event-listener");
+var import_use_timer = require("@usefy/use-timer");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   useClickAnyWhere,
@@ -59,6 +61,7 @@ var import_use_event_listener = require("@usefy/use-event-listener");
   useSessionStorage,
   useThrottle,
   useThrottleCallback,
+  useTimer,
   useToggle
 });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Re-export all hooks from individual packages\n\n// useClickAnyWhere\nexport {\n  useClickAnyWhere,\n  type UseClickAnyWhereOptions,\n  type ClickAnyWhereHandler,\n} from \"@usefy/use-click-any-where\";\n\n// useCopyToClipboard\nexport {\n  useCopyToClipboard,\n  type UseCopyToClipboardOptions,\n  type UseCopyToClipboardReturn,\n  type CopyFn,\n} from \"@usefy/use-copy-to-clipboard\";\n\n// useCounter\nexport { useCounter } from \"@usefy/use-counter\";\n\n// useToggle\nexport { useToggle, type UseToggleReturn } from \"@usefy/use-toggle\";\n\n// useDebounce\nexport { useDebounce, type UseDebounceOptions } from \"@usefy/use-debounce\";\n\n// useDebounceCallback\nexport {\n  useDebounceCallback,\n  type UseDebounceCallbackOptions,\n  type DebouncedFunction,\n} from \"@usefy/use-debounce-callback\";\n\n// useThrottle\nexport { useThrottle, type UseThrottleOptions } from \"@usefy/use-throttle\";\n\n// useThrottleCallback\nexport {\n  useThrottleCallback,\n  type UseThrottleCallbackOptions,\n  type ThrottledFunction,\n} from \"@usefy/use-throttle-callback\";\n\n// useLocalStorage\nexport {\n  useLocalStorage,\n  type UseLocalStorageOptions,\n  type UseLocalStorageReturn,\n  type InitialValue,\n} from \"@usefy/use-local-storage\";\n\n// useSessionStorage\nexport {\n  useSessionStorage,\n  type UseSessionStorageOptions,\n  type UseSessionStorageReturn,\n  type InitialValue as SessionStorageInitialValue,\n} from \"@usefy/use-session-storage\";\n\n// useOnClickOutside\nexport {\n  useOnClickOutside,\n  type UseOnClickOutsideOptions,\n  type OnClickOutsideHandler,\n  type ClickOutsideEvent,\n  type RefTarget,\n  type MouseEventType,\n  type TouchEventType,\n} from \"@usefy/use-on-click-outside\";\n\n// useEventListener\nexport {\n  useEventListener,\n  type UseEventListenerOptions,\n  type EventTargetType,\n} from \"@usefy/use-event-listener\";\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,iCAIO;AAGP,mCAKO;AAGP,yBAA2B;AAG3B,wBAAgD;AAGhD,0BAAqD;AAGrD,mCAIO;AAGP,0BAAqD;AAGrD,mCAIO;AAGP,+BAKO;AAGP,iCAKO;AAGP,kCAQO;AAGP,gCAIO;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Re-export all hooks from individual packages\n\n// useClickAnyWhere\nexport {\n  useClickAnyWhere,\n  type UseClickAnyWhereOptions,\n  type ClickAnyWhereHandler,\n} from \"@usefy/use-click-any-where\";\n\n// useCopyToClipboard\nexport {\n  useCopyToClipboard,\n  type UseCopyToClipboardOptions,\n  type UseCopyToClipboardReturn,\n  type CopyFn,\n} from \"@usefy/use-copy-to-clipboard\";\n\n// useCounter\nexport { useCounter } from \"@usefy/use-counter\";\n\n// useToggle\nexport { useToggle, type UseToggleReturn } from \"@usefy/use-toggle\";\n\n// useDebounce\nexport { useDebounce, type UseDebounceOptions } from \"@usefy/use-debounce\";\n\n// useDebounceCallback\nexport {\n  useDebounceCallback,\n  type UseDebounceCallbackOptions,\n  type DebouncedFunction,\n} from \"@usefy/use-debounce-callback\";\n\n// useThrottle\nexport { useThrottle, type UseThrottleOptions } from \"@usefy/use-throttle\";\n\n// useThrottleCallback\nexport {\n  useThrottleCallback,\n  type UseThrottleCallbackOptions,\n  type ThrottledFunction,\n} from \"@usefy/use-throttle-callback\";\n\n// useLocalStorage\nexport {\n  useLocalStorage,\n  type UseLocalStorageOptions,\n  type UseLocalStorageReturn,\n  type InitialValue,\n} from \"@usefy/use-local-storage\";\n\n// useSessionStorage\nexport {\n  useSessionStorage,\n  type UseSessionStorageOptions,\n  type UseSessionStorageReturn,\n  type InitialValue as SessionStorageInitialValue,\n} from \"@usefy/use-session-storage\";\n\n// useOnClickOutside\nexport {\n  useOnClickOutside,\n  type UseOnClickOutsideOptions,\n  type OnClickOutsideHandler,\n  type ClickOutsideEvent,\n  type RefTarget,\n  type MouseEventType,\n  type TouchEventType,\n} from \"@usefy/use-on-click-outside\";\n\n// useEventListener\nexport {\n  useEventListener,\n  type UseEventListenerOptions,\n  type EventTargetType,\n} from \"@usefy/use-event-listener\";\n\n// useTimer\nexport {\n  useTimer,\n  type TimeUnit,\n  type TimeFormat,\n  type UseTimerOptions,\n  type UseTimerReturn,\n} from \"@usefy/use-timer\";\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,iCAIO;AAGP,mCAKO;AAGP,yBAA2B;AAG3B,wBAAgD;AAGhD,0BAAqD;AAGrD,mCAIO;AAGP,0BAAqD;AAGrD,mCAIO;AAGP,+BAKO;AAGP,iCAKO;AAGP,kCAQO;AAGP,gCAIO;AAGP,uBAMO;","names":[]}

package/dist/index.mjs

@@ -27,6 +27,9 @@ import {
 import {
   useEventListener
 } from "@usefy/use-event-listener";
+import {
+  useTimer
+} from "@usefy/use-timer";
 export {
   useClickAnyWhere,
   useCopyToClipboard,
@@ -39,6 +42,7 @@ export {
   useSessionStorage,
   useThrottle,
   useThrottleCallback,
+  useTimer,
   useToggle
 };
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Re-export all hooks from individual packages\n\n// useClickAnyWhere\nexport {\n  useClickAnyWhere,\n  type UseClickAnyWhereOptions,\n  type ClickAnyWhereHandler,\n} from \"@usefy/use-click-any-where\";\n\n// useCopyToClipboard\nexport {\n  useCopyToClipboard,\n  type UseCopyToClipboardOptions,\n  type UseCopyToClipboardReturn,\n  type CopyFn,\n} from \"@usefy/use-copy-to-clipboard\";\n\n// useCounter\nexport { useCounter } from \"@usefy/use-counter\";\n\n// useToggle\nexport { useToggle, type UseToggleReturn } from \"@usefy/use-toggle\";\n\n// useDebounce\nexport { useDebounce, type UseDebounceOptions } from \"@usefy/use-debounce\";\n\n// useDebounceCallback\nexport {\n  useDebounceCallback,\n  type UseDebounceCallbackOptions,\n  type DebouncedFunction,\n} from \"@usefy/use-debounce-callback\";\n\n// useThrottle\nexport { useThrottle, type UseThrottleOptions } from \"@usefy/use-throttle\";\n\n// useThrottleCallback\nexport {\n  useThrottleCallback,\n  type UseThrottleCallbackOptions,\n  type ThrottledFunction,\n} from \"@usefy/use-throttle-callback\";\n\n// useLocalStorage\nexport {\n  useLocalStorage,\n  type UseLocalStorageOptions,\n  type UseLocalStorageReturn,\n  type InitialValue,\n} from \"@usefy/use-local-storage\";\n\n// useSessionStorage\nexport {\n  useSessionStorage,\n  type UseSessionStorageOptions,\n  type UseSessionStorageReturn,\n  type InitialValue as SessionStorageInitialValue,\n} from \"@usefy/use-session-storage\";\n\n// useOnClickOutside\nexport {\n  useOnClickOutside,\n  type UseOnClickOutsideOptions,\n  type OnClickOutsideHandler,\n  type ClickOutsideEvent,\n  type RefTarget,\n  type MouseEventType,\n  type TouchEventType,\n} from \"@usefy/use-on-click-outside\";\n\n// useEventListener\nexport {\n  useEventListener,\n  type UseEventListenerOptions,\n  type EventTargetType,\n} from \"@usefy/use-event-listener\";\n"],"mappings":";AAGA;AAAA,EACE;AAAA,OAGK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP,SAAS,kBAAkB;AAG3B,SAAS,iBAAuC;AAGhD,SAAS,mBAA4C;AAGrD;AAAA,EACE;AAAA,OAGK;AAGP,SAAS,mBAA4C;AAGrD;AAAA,EACE;AAAA,OAGK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP;AAAA,EACE;AAAA,OAOK;AAGP;AAAA,EACE;AAAA,OAGK;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Re-export all hooks from individual packages\n\n// useClickAnyWhere\nexport {\n  useClickAnyWhere,\n  type UseClickAnyWhereOptions,\n  type ClickAnyWhereHandler,\n} from \"@usefy/use-click-any-where\";\n\n// useCopyToClipboard\nexport {\n  useCopyToClipboard,\n  type UseCopyToClipboardOptions,\n  type UseCopyToClipboardReturn,\n  type CopyFn,\n} from \"@usefy/use-copy-to-clipboard\";\n\n// useCounter\nexport { useCounter } from \"@usefy/use-counter\";\n\n// useToggle\nexport { useToggle, type UseToggleReturn } from \"@usefy/use-toggle\";\n\n// useDebounce\nexport { useDebounce, type UseDebounceOptions } from \"@usefy/use-debounce\";\n\n// useDebounceCallback\nexport {\n  useDebounceCallback,\n  type UseDebounceCallbackOptions,\n  type DebouncedFunction,\n} from \"@usefy/use-debounce-callback\";\n\n// useThrottle\nexport { useThrottle, type UseThrottleOptions } from \"@usefy/use-throttle\";\n\n// useThrottleCallback\nexport {\n  useThrottleCallback,\n  type UseThrottleCallbackOptions,\n  type ThrottledFunction,\n} from \"@usefy/use-throttle-callback\";\n\n// useLocalStorage\nexport {\n  useLocalStorage,\n  type UseLocalStorageOptions,\n  type UseLocalStorageReturn,\n  type InitialValue,\n} from \"@usefy/use-local-storage\";\n\n// useSessionStorage\nexport {\n  useSessionStorage,\n  type UseSessionStorageOptions,\n  type UseSessionStorageReturn,\n  type InitialValue as SessionStorageInitialValue,\n} from \"@usefy/use-session-storage\";\n\n// useOnClickOutside\nexport {\n  useOnClickOutside,\n  type UseOnClickOutsideOptions,\n  type OnClickOutsideHandler,\n  type ClickOutsideEvent,\n  type RefTarget,\n  type MouseEventType,\n  type TouchEventType,\n} from \"@usefy/use-on-click-outside\";\n\n// useEventListener\nexport {\n  useEventListener,\n  type UseEventListenerOptions,\n  type EventTargetType,\n} from \"@usefy/use-event-listener\";\n\n// useTimer\nexport {\n  useTimer,\n  type TimeUnit,\n  type TimeFormat,\n  type UseTimerOptions,\n  type UseTimerReturn,\n} from \"@usefy/use-timer\";\n"],"mappings":";AAGA;AAAA,EACE;AAAA,OAGK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP,SAAS,kBAAkB;AAG3B,SAAS,iBAAuC;AAGhD,SAAS,mBAA4C;AAGrD;AAAA,EACE;AAAA,OAGK;AAGP,SAAS,mBAA4C;AAGrD;AAAA,EACE;AAAA,OAGK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP;AAAA,EACE;AAAA,OAIK;AAGP;AAAA,EACE;AAAA,OAOK;AAGP;AAAA,EACE;AAAA,OAGK;AAGP;AAAA,EACE;AAAA,OAKK;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usefy/usefy",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "description": "A collection of useful React hooks",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -17,18 +17,19 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@usefy/use-click-any-where": "0.0.18",
-    "@usefy/use-copy-to-clipboard": "0.0.18",
-    "@usefy/use-counter": "0.0.18",
-    "@usefy/use-toggle": "0.0.18",
-    "@usefy/use-debounce": "0.0.18",
-    "@usefy/use-debounce-callback": "0.0.18",
-    "@usefy/use-throttle": "0.0.18",
-    "@usefy/use-throttle-callback": "0.0.18",
-    "@usefy/use-local-storage": "0.0.18",
-    "@usefy/use-session-storage": "0.0.18",
-    "@usefy/use-on-click-outside": "0.0.18",
-    "@usefy/use-event-listener": "0.0.18"
+    "@usefy/use-click-any-where": "0.0.19",
+    "@usefy/use-copy-to-clipboard": "0.0.19",
+    "@usefy/use-counter": "0.0.19",
+    "@usefy/use-toggle": "0.0.19",
+    "@usefy/use-debounce": "0.0.19",
+    "@usefy/use-debounce-callback": "0.0.19",
+    "@usefy/use-throttle": "0.0.19",
+    "@usefy/use-throttle-callback": "0.0.19",
+    "@usefy/use-local-storage": "0.0.19",
+    "@usefy/use-session-storage": "0.0.19",
+    "@usefy/use-on-click-outside": "0.0.19",
+    "@usefy/use-event-listener": "0.0.19",
+    "@usefy/use-timer": "0.0.19"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0"