react-simplikit 0.0.18 → 0.0.20

package/dist/hooks/useBooleanState/index.d.cts

@@ -5,7 +5,7 @@
  *
  * @param {boolean} [defaultValue=false] - The initial value of the state. Defaults to `false`.
  *
- * @returns {[state: boolean, setTrue: () => void, setFalse: () => void, toggle: () => void]} A tuple containing:
+ * @returns {readonly [state: boolean, setTrue: () => void, setFalse: () => void, toggle: () => void]} A tuple containing:
  * - state `boolean` - The current state value;
  * - setTrue `() => void` - A function to set the state to `true`;
  * - setFalse `() => void` - A function to set the state to `false`;

package/dist/hooks/useStorageState/index.d.cts

@@ -27,7 +27,7 @@ type StorageStateOptionsWithDefaultValue<T> = StorageStateOptions<T> & {
  * @param {Storage} [options.storage=localStorage] - The storage type (`localStorage` or `sessionStorage`). Defaults to `localStorage`.
  * @param {T} [options.defaultValue] - The initial value if no existing value is found.
  *
- * @returns {[state: Serializable<T> | undefined, setState: (value: SetStateAction<Serializable<T> | undefined>) => void]} A tuple:
+ * @returns {readonly [state: Serializable<T> | undefined, setState: (value: SetStateAction<Serializable<T> | undefined>) => void]} A tuple:
  * - state `Serializable<T> | undefined` - The current state value retrieved from storage;
  * - setState `(value: SetStateAction<Serializable<T> | undefined>) => void` - A function to update and persist the state;
  *

package/dist/utils/mergeRefs/index.d.cts

@@ -5,6 +5,8 @@ import { RefObject, RefCallback } from 'react';
  * This function takes multiple refs (RefObject or RefCallback) and returns a single ref that updates all provided refs.
  * It's useful when you need to pass multiple refs to a single element.
  *
+ * @template T - The type of target to be referenced.
+ *
  * @param {Array<RefObject<T> | RefCallback<T> | null | undefined>} refs - An array of refs to be merged. Each ref can be either a RefObject or RefCallback.
  *
  * @returns {RefCallback<T>} A single ref callback that updates all provided refs.

package/esm/hooks/useBooleanState/index.d.ts

@@ -5,7 +5,7 @@
  *
  * @param {boolean} [defaultValue=false] - The initial value of the state. Defaults to `false`.
  *
- * @returns {[state: boolean, setTrue: () => void, setFalse: () => void, toggle: () => void]} A tuple containing:
+ * @returns {readonly [state: boolean, setTrue: () => void, setFalse: () => void, toggle: () => void]} A tuple containing:
  * - state `boolean` - The current state value;
  * - setTrue `() => void` - A function to set the state to `true`;
  * - setFalse `() => void` - A function to set the state to `false`;

package/esm/hooks/useStorageState/index.d.ts

@@ -27,7 +27,7 @@ type StorageStateOptionsWithDefaultValue<T> = StorageStateOptions<T> & {
  * @param {Storage} [options.storage=localStorage] - The storage type (`localStorage` or `sessionStorage`). Defaults to `localStorage`.
  * @param {T} [options.defaultValue] - The initial value if no existing value is found.
  *
- * @returns {[state: Serializable<T> | undefined, setState: (value: SetStateAction<Serializable<T> | undefined>) => void]} A tuple:
+ * @returns {readonly [state: Serializable<T> | undefined, setState: (value: SetStateAction<Serializable<T> | undefined>) => void]} A tuple:
  * - state `Serializable<T> | undefined` - The current state value retrieved from storage;
  * - setState `(value: SetStateAction<Serializable<T> | undefined>) => void` - A function to update and persist the state;
  *

package/esm/utils/mergeRefs/index.d.ts

@@ -5,6 +5,8 @@ import { RefObject, RefCallback } from 'react';
  * This function takes multiple refs (RefObject or RefCallback) and returns a single ref that updates all provided refs.
  * It's useful when you need to pass multiple refs to a single element.
  *
+ * @template T - The type of target to be referenced.
+ *
  * @param {Array<RefObject<T> | RefCallback<T> | null | undefined>} refs - An array of refs to be merged. Each ref can be either a RefObject or RefCallback.
  *
  * @returns {RefCallback<T>} A single ref callback that updates all provided refs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-simplikit",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "main": "./dist/index.cjs",
   "type": "module",
   "sideEffects": false,
@@ -19,6 +19,7 @@
     "esm/**/*"
   ],
   "scripts": {
+    "clean": "rimraf ./dist ./esm ./coverage ./node_modules",
     "scaffold": "tsx .scripts/index.ts scaffold",
     "docs:gen": "tsx .scripts/index.ts generate-docs",
     "docs:dev": "vitepress dev",
@@ -88,6 +89,7 @@
     "prettier-plugin-sort-re-exports": "^0.1.0",
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
+    "rimraf": "^6.0.1",
     "tsup": "^8.3.5",
     "tsx": "^4.19.2",
     "typescript": "^5.7.2",