@siberiacancode/reactuse 0.0.52 → 0.0.54

package/dist/index.d.ts

@@ -150,17 +150,23 @@ interface UseCopyToClipboardReturn {
     /** Whether the copy to clipboard is supported */
     supported: boolean;
 }
+/** The use copy to clipboard params type */
+interface UseCopyToClipboardParams {
+    /** Whether the copy to clipboard is enabled */
+    enabled: boolean;
+}
 /**
  * @name useClipboard
  * @description - Hook that manages a copy to clipboard
  * @category Browser
  *
+ * @param {boolean} [params.enabled=false] Whether the copy to clipboard is enabled
  * @returns {UseCopyToClipboardReturn} An object containing the boolean state value and utility functions to manipulate the state
  *
  * @example
  * const { supported, value, copy } = useClipboard();
  */
-declare const useClipboard: () => UseCopyToClipboardReturn;
+declare const useClipboard: (params?: UseCopyToClipboardParams) => UseCopyToClipboardReturn;
 
 /** The use counter options */
 interface UseCounterOptions {
@@ -803,6 +809,7 @@ interface UseQueryOptions<QueryData, Data> {
     placeholderData?: Data | (() => Data);
     retry?: boolean | number;
     refetchInterval?: number;
+    enabled?: boolean;
 }
 interface UseQueryReturn<Data> {
     data?: Data;
@@ -1141,7 +1148,26 @@ interface UseStorageOptions<Value> {
     storage?: Storage;
     initialValue?: UseStorageInitialValue<Value>;
 }
-declare const useStorage: <Value>(key: string, params?: UseStorageInitialValue<Value> | UseStorageOptions<Value>) => readonly [Value | undefined, (value: Value) => void, () => void];
+/**
+ * @name useStorage
+ * @description - Hook that manages storage value
+ * @category Utilities
+ *
+ * @param {string} key The key of the storage
+ * @param {(value: Value) => string} [params.serializer] The serializer function
+ * @param {(value: string) => Value} [params.deserializer] The deserializer function
+ * @param {Storage} [params.storage] The storage
+ * @param {UseStorageInitialValue<Value>} [params.initialValue] The initial value of the storage
+ * @returns {UseStorageReturn<Value>} The value and the set function
+ *
+ * @example
+ * const { value, set, remove } = useStorage('key', 'value');
+ */
+declare const useStorage: <Value>(key: string, params?: UseStorageInitialValue<Value> | UseStorageOptions<Value>) => {
+    value: Value | undefined;
+    set: (value: Value) => void;
+    remove: () => void;
+};
 
 /**
  * @name useLocalStorage
@@ -1154,9 +1180,13 @@ declare const useStorage: <Value>(key: string, params?: UseStorageInitialValue<V
  * @param {UseStorageOptions<Value>} [options] The options of the storage
  *
  * @example
- * const [value, setValue, removeValue] = useLocalStorage('key', 'value');
+ * const { value, set, remove } = useLocalStorage('key', 'value');
  */
-declare const useLocalStorage: <Value>(key: string, initialValue?: UseStorageInitialValue<Value>, options?: UseStorageOptions<Value>) => readonly [Value | undefined, (value: Value) => void, () => void];
+declare const useLocalStorage: <Value>(key: string, initialValue?: UseStorageInitialValue<Value>, options?: UseStorageOptions<Value>) => {
+    value: Value | undefined;
+    set: (value: Value) => void;
+    remove: () => void;
+};
 
 /**
  * @name useLogger
@@ -1857,9 +1887,13 @@ declare const useScript: (src: string, options?: UseScriptOptions) => UseScriptS
  * @param {UseStorageOptions<Value>} [options] The options of the storage
  *
  * @example
- * const [value, setValue, removeValue] = useSessionStorage('key', 'value');
+ * const { value, set, remove } = useSessionStorage('key', 'value');
  */
-declare const useSessionStorage: <Value>(key: string, initialValue?: UseStorageInitialValue<Value>, options?: UseStorageOptions<Value>) => readonly [Value | undefined, (value: Value) => void, () => void];
+declare const useSessionStorage: <Value>(key: string, initialValue?: UseStorageInitialValue<Value>, options?: UseStorageOptions<Value>) => {
+    value: Value | undefined;
+    set: (value: Value) => void;
+    remove: () => void;
+};
 
 declare global {
     interface Set<T> {
@@ -2027,6 +2061,7 @@ type UseStopwatch = {
 /**
  * @name useStopwatch
  * @description - Hook that creates a stopwatch functionality
+ * @category Time
  *
  * @overload
  * @param {number} [initialTime=0] The initial time of the timer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.52",
+  "version": "0.0.54",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {

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

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

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

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