@siberiacancode/reactuse 0.0.105 → 0.0.107

package/dist/types/index.d.ts

@@ -2000,9 +2000,11 @@ declare const useLatest: <Value>(value: Value) => Value;
 
 /**
  * @name useLess
- * @description - Hook that humorously suggests using it less not for production
+ * @description - Hook that can be so useless
  * @category Humor
  *
+ * @warning - This hook is a joke. Please do not use it in production code!
+ *
  * @template Value The type of the value
  * @param {Value} [value] The value to be returned
  * @returns {Value} The value passed to the hook
@@ -2010,7 +2012,7 @@ declare const useLatest: <Value>(value: Value) => Value;
  * @example
  * const value = useLess(state);
  */
-declare const useLess: (value?: any) => any;
+declare const useLess: <Value>(value?: Value) => Value | undefined;
 
 /** The use list return type */
 interface UseListReturn<Item> {
@@ -3848,6 +3850,12 @@ interface UseTimerReturn {
     minutes: number;
     /** The second count of the timer */
     seconds: number;
+    /** The function to clear the timer */
+    clear: () => void;
+    /** The function to decrease the timer */
+    decrease: (seconds: number) => void;
+    /** The function to increase the timer */
+    increase: (seconds: number) => void;
     /** The function to pause the timer */
     pause: () => void;
     /** The function to restart the timer */
@@ -3858,10 +3866,12 @@ interface UseTimerReturn {
     start: () => void;
     /** The function to toggle the timer */
     toggle: () => void;
+    /** The function to update the timer */
+    update: (seconds: number) => void;
 }
 interface UseTimer {
-    (timestamp: number, callback: () => void): UseTimerReturn;
-    (timestamp: number, options?: UseTimerOptions): UseTimerReturn;
+    (seconds: number, callback: () => void): UseTimerReturn;
+    (seconds: number, options?: UseTimerOptions): UseTimerReturn;
 }
 /**
  * @name useTimer
@@ -3869,17 +3879,19 @@ interface UseTimer {
  * @category Time
  *
  * @overload
- * @param {number} timestamp The timestamp value that define for how long the timer will be running
+ * @param {number} seconds The seconds value that define for how long the timer will be running
  * @param {() => void} callback The function to be executed once countdown timer is expired
+ * @returns {UseTimerReturn} An object containing the timer properties and functions
  *
  * @example
  * const { days, hours, minutes, seconds, toggle, pause, start, restart, resume, active } = useTimer(1000, () => console.log('ready'));
  *
  * @overload
- * @param {number} timestamp The timestamp value that define for how long the timer will be running
- * @param {boolean} options.immediately The flag to decide if timer should start automatically
- * @param {() => void} options.onExpire The function to be executed when the timer is expired
- * @param {(timestamp: number) => void} options.onTick The function to be executed on each tick of the timer
+ * @param {number} seconds The seconds value that define for how long the timer will be running
+ * @param {boolean} [options.immediately=true] The flag to decide if timer should start automatically
+ * @param {() => void} [options.onExpire] The function to be executed when the timer is expired
+ * @param {(timestamp: number) => void} [options.onTick] The function to be executed on each tick of the timer
+ * @returns {UseTimerReturn} An object containing the timer properties and functions
  *
  * @example
  * const { days, hours, minutes, seconds, toggle, pause, start, restart, resume, active } = useTimer(1000);

package/package.json

@@ -1,91 +1,91 @@
-{
-  "name": "@siberiacancode/reactuse",
-  "version": "0.0.105",
-  "description": "The ultimate collection of react hooks",
-  "author": {
-    "name": "SIBERIA CAN CODE 🧊",
-    "url": "https://github.com/siberiacancode"
-  },
-  "license": "MIT",
-  "homepage": "https://siberiacancode.github.io/reactuse/",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/siberiacancode/reactuse.git",
-    "directory": "packages/core"
-  },
-  "bugs": "https://github.com/siberiacancode/reactuse/issues",
-  "keywords": [
-    "react",
-    "react hooks",
-    "react use",
-    "use",
-    "hooks"
-  ],
-  "sideEffects": false,
-  "exports": {
-    "types": "./dist/types/index.d.ts",
-    "import": "./dist/esm/index.js",
-    "require": "./dist/cjs/index.cjs"
-  },
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "engines": {
-    "node": ">=14"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "prepublishOnly": "pnpm unit-test run && pnpm build",
-    "build": "shx rm -rf dist && rollup -c --bundleConfigAsCjs",
-    "build:js": "tsc --project tsconfig.build.json",
-    "lint": "eslint . --fix",
-    "lint-inspector": "npx @eslint/config-inspector@latest",
-    "format": "prettier --write .",
-    "pretty": "pnpm lint && pnpm format",
-    "unit-test": "vitest",
-    "lint-staged": "lint-staged"
-  },
-  "peerDependencies": {
-    "@types/react": "^18.0.0",
-    "react": "^17.0.2 || ^18.0.0",
-    "react-dom": "^17.0.2 || ^18.0.0"
-  },
-  "peerDependenciesMeta": {
-    "@types/react": {
-      "optional": true
-    }
-  },
-  "dependencies": {
-    "screenfull": "^6.0.2"
-  },
-  "devDependencies": {
-    "@siberiacancode/builder": "^1.3.17",
-    "@siberiacancode/vitest": "^2.0.2",
-    "@testing-library/dom": "^10.4.0",
-    "@testing-library/react": "^16.2.0",
-    "@types/react": "^18.3.18",
-    "@types/react-dom": "^18.3.5",
-    "@types/web-bluetooth": "^0.0.20",
-    "core-js": "^3.40.0",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "shx": "^0.3.4",
-    "vite": "^6.1.1",
-    "vitest": "^3.0.6"
-  },
-  "lint-staged": {
-    "*.js": [
-      "eslint --fix",
-      "prettier --write"
-    ],
-    "*.ts": [
-      "eslint --fix",
-      "prettier --write"
-    ]
-  }
-}
+{
+  "name": "@siberiacancode/reactuse",
+  "version": "0.0.107",
+  "description": "The ultimate collection of react hooks",
+  "author": {
+    "name": "SIBERIA CAN CODE 🧊",
+    "url": "https://github.com/siberiacancode"
+  },
+  "license": "MIT",
+  "homepage": "https://siberiacancode.github.io/reactuse/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/siberiacancode/reactuse.git",
+    "directory": "packages/core"
+  },
+  "bugs": "https://github.com/siberiacancode/reactuse/issues",
+  "keywords": [
+    "react",
+    "react hooks",
+    "react use",
+    "use",
+    "hooks"
+  ],
+  "sideEffects": false,
+  "exports": {
+    "types": "./dist/types/index.d.ts",
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.cjs"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepublishOnly": "pnpm unit-test run && pnpm build",
+    "build": "shx rm -rf dist && rollup -c --bundleConfigAsCjs",
+    "build:js": "tsc --project tsconfig.build.json",
+    "lint": "eslint . --fix",
+    "lint-inspector": "npx @eslint/config-inspector@latest",
+    "format": "prettier --write .",
+    "pretty": "pnpm lint && pnpm format",
+    "unit-test": "vitest",
+    "lint-staged": "lint-staged"
+  },
+  "peerDependencies": {
+    "@types/react": "^18.0.0",
+    "react": "^17.0.2 || ^18.0.0",
+    "react-dom": "^17.0.2 || ^18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@types/react": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "screenfull": "^6.0.2"
+  },
+  "devDependencies": {
+    "@siberiacancode/builder": "^1.3.17",
+    "@siberiacancode/vitest": "^2.0.2",
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/react": "^16.2.0",
+    "@types/react": "^18.3.18",
+    "@types/react-dom": "^18.3.5",
+    "@types/web-bluetooth": "^0.0.20",
+    "core-js": "^3.40.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "shx": "^0.3.4",
+    "vite": "^6.1.1",
+    "vitest": "^3.0.6"
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.ts": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  }
+}

package/dist/cjs/_rollupPluginBabelHelpers-EyHDAJng.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-EyHDAJng.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/esm/_rollupPluginBabelHelpers-ClXxr7lu.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-ClXxr7lu.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}