@siberiacancode/reactuse 0.2.28 → 0.2.30

package/dist/types/hooks/useIntersectionObserver/useIntersectionObserver.d.ts

@@ -1,16 +1,24 @@
 import { HookTarget } from '../../utils/helpers';
 import { StateRef } from '../useRefState/useRefState';
-export type UseIntersectionObserverCallback = (entry: IntersectionObserverEntry) => void;
+/** The intersection observer callback type */
+export type UseIntersectionObserverCallback = (entry: IntersectionObserverEntry, observer: IntersectionObserver) => void;
 /** The intersection observer options type */
 export interface UseIntersectionObserverOptions extends Omit<IntersectionObserverInit, 'root'> {
+    /** The enabled state of the intersection observer */
     enabled?: boolean;
+    /** The callback to execute when intersection is detected */
     onChange?: UseIntersectionObserverCallback;
+    /** The root element to observe */
     root?: HookTarget;
 }
 /** The intersection observer return type */
 export interface UseIntersectionObserverReturn {
+    /** The intersection observer entry */
     entry?: IntersectionObserverEntry;
+    /** The in view state of the intersection observer */
     inView: boolean;
+    /** The intersection observer instance */
+    observer?: IntersectionObserver;
 }
 export interface UseIntersectionObserver {
     <Target extends Element>(options?: UseIntersectionObserverOptions, target?: never): UseIntersectionObserverReturn & {
@@ -20,12 +28,13 @@ export interface UseIntersectionObserver {
     <Target extends Element>(callback: UseIntersectionObserverCallback, target?: never): UseIntersectionObserverReturn & {
         ref: StateRef<Target>;
     };
-    (callback: UseIntersectionObserverCallback, target: HookTarget): UseIntersectionObserverReturn;
+    (target: HookTarget, callback: UseIntersectionObserverCallback): UseIntersectionObserverReturn;
 }
 /**
  * @name useIntersectionObserver
  * @description - Hook that gives you intersection observer state
  * @category Sensors
+ * @usage medium
  *
  * @browserapi IntersectionObserver https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver
  *
@@ -37,7 +46,7 @@ export interface UseIntersectionObserver {
  * @returns {UseIntersectionObserverReturn} An object containing the state
  *
  * @example
- * const { ref, entry, inView } = useIntersectionObserver();
+ * const { ref, entry, inView, observer } = useIntersectionObserver();
  *
  * @overload
  * @template Target The target element
@@ -47,7 +56,7 @@ export interface UseIntersectionObserver {
  * @returns {UseIntersectionObserverReturn & { ref: StateRef<Target> }} A React ref to attach to the target element
  *
  * @example
- * const { entry, inView } = useIntersectionObserver(ref);
+ * const { entry, inView, observer } = useIntersectionObserver(ref);
  *
  * @overload
  * @template Target The target element
@@ -55,7 +64,7 @@ export interface UseIntersectionObserver {
  * @returns {UseIntersectionObserverReturn & { ref: StateRef<Target> }} A React ref to attach to the target element
  *
  * @example
- * const { ref, entry, inView } = useIntersectionObserver(() => console.log('callback'));
+ * const { ref, entry, inView, observer } = useIntersectionObserver(() => console.log('callback'));
  *
  * @overload
  * @param {UseIntersectionObserverCallback} callback The callback to execute when intersection is detected
@@ -63,6 +72,6 @@ export interface UseIntersectionObserver {
  * @returns {UseIntersectionObserverReturn} An object containing the state
  *
  * @example
- * const { entry, inView } = useIntersectionObserver(() => console.log('callback'), ref);
+ * const { entry, inView, observer } = useIntersectionObserver(() => console.log('callback'), ref);
  */
 export declare const useIntersectionObserver: UseIntersectionObserver;

package/dist/types/hooks/useInterval/useInterval.d.ts

@@ -24,6 +24,7 @@ interface UseInterval {
  * @name useInterval
  * @description - Hook that makes and interval and returns controlling functions
  * @category Time
+ * @usage high
  *
  * @overload
  * @param {() => void} callback Any callback function

package/dist/types/hooks/useIsFirstRender/useIsFirstRender.d.ts

@@ -2,6 +2,7 @@
  * @name useIsFirstRender
  * @description - Hook that returns true if the component is first render
  * @category Lifecycle
+ * @usage low
  *
  * @returns {boolean} True if the component is first render
  *

package/dist/types/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.d.ts

@@ -3,6 +3,7 @@ import { useEffect } from 'react';
  * @name useIsomorphicLayoutEffect
  * @description - Hook conditionally selects either `useLayoutEffect` or `useEffect` based on the environment
  * @category Lifecycle
+ * @usage high
  *
  * @example
  * useIsomorphicLayoutEffect(() => console.log('effect'), [])

package/dist/types/hooks/useKeyPress/useKeyPress.d.ts

@@ -15,6 +15,7 @@ export interface UseKeyPress {
  * @name useKeyPress
  * @description - Hook that listens for key press events
  * @category Sensors
+ * @usage medium
  *
  * @overload
  * @param {HookTarget} [target=window] The target to attach the event listeners to

package/dist/types/hooks/useKeyPressEvent/useKeyPressEvent.d.ts

@@ -21,6 +21,7 @@ export interface UseKeyPressEvent {
  * @name useKeyPressEvent
  * @description - Hook that listens for key press events on specified targets
  * @category Sensors
+ * @usage low
  *
  * @overload
  * @param {UseKeyPressEventKey} key The key or array of keys to listen for.

package/dist/types/hooks/useKeyboard/useKeyboard.d.ts

@@ -23,6 +23,7 @@ export interface UseKeyboard {
  * @name useKeyboard
  * @description - Hook that helps to listen for keyboard events
  * @category Sensors
+ * @usage medium
  *
  * @overload
  * @param {HookTarget} target The target to attach the event listeners to

package/dist/types/hooks/useKeysPressed/useKeysPressed.d.ts

@@ -19,11 +19,10 @@ export interface UseKeysPressed {
     };
 }
 /**
- * Hook that tracks which keyboard keys are currently pressed
- *
  * @name useKeysPressed
  * @description Tracks all currently pressed keyboard keys and their codes
  * @category Sensors
+ * @usage low
  *
  * @overload
  * @param {HookTarget | Window} target DOM element or ref to attach keyboard listeners to

package/dist/types/hooks/useLastChanged/useLastChanged.d.ts

@@ -6,6 +6,7 @@ export interface UseLastChangedOptions {
  * @name useLastChanged
  * @description - Hook for records the timestamp of the last change
  * @category Utilities
+ * @usage low
  *
  * @param {any} source  The source of the last change
  * @param {number | null} [options.initialValue=null] The initial value

package/dist/types/hooks/useLatest/useLatest.d.ts

@@ -7,6 +7,7 @@ export interface UseLatestReturn<Value> {
  * @name useLatest
  * @description - Hook that returns the stable reference of the value
  * @category Utilities
+ * @usage medium
  *
  * @template Value The type of the value
  * @param {Value} value The value to get the previous value

package/dist/types/hooks/useLess/useLess.d.ts

@@ -2,6 +2,7 @@
  * @name useLess
  * @description - Hook that can be so useless
  * @category Humor
+ * @usage low
  *
  * @warning - This hook is a joke. Please do not use it in production code!
  *

package/dist/types/hooks/useList/useList.d.ts

@@ -19,6 +19,7 @@ export interface UseListReturn<Item> {
  * @name useList
  * @description - Hook that provides state and helper methods to manage a list of items
  * @category State
+ * @usage medium
  *
  * @template Item The type of the item
  * @param {Item[] | (() => Item[])} initialList The initial list of items

package/dist/types/hooks/useLocalStorage/useLocalStorage.d.ts

@@ -3,6 +3,7 @@ import { UseStorageInitialValue, UseStorageOptions } from '../useStorage/useStor
  * @name useLocalStorage
  * @description - Hook that manages local storage value
  * @category State
+ * @usage high
  *
  * @browserapi localStorage https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage
  *

package/dist/types/hooks/useLockCallback/useLockCallback.d.ts

@@ -2,6 +2,7 @@
  * @name useLockCallback
  * @description - Hook that prevents a callback from being executed multiple times simultaneously
  * @category Async
+ * @usage medium
  *
  * @param {Function} callback The callback to be locked
  * @returns {Function} The locked callback

package/dist/types/hooks/useLockScroll/useLockScroll.d.ts

@@ -28,7 +28,7 @@ export interface UseLockScroll {
  * @name useLockScroll
  * @description - Hook that locks scroll on an element or document body
  * @category Elements
- *
+ * @usage medium
  *
  * @overload
  * @param {HookTarget} [target=document.body] The target element to lock scroll on

package/dist/types/hooks/useLogger/useLogger.d.ts

@@ -2,6 +2,7 @@
  * @name useLogger
  * @description - Hook for debugging lifecycle
  * @category Debug
+ * @usage low
  *
  * @param {string} name The name or identifier for the logger
  * @param {unknown[]} params Additional arguments to be logged

package/dist/types/hooks/useLongPress/useLongPress.d.ts

@@ -18,6 +18,7 @@ export interface UseLongPress {
  * @name useLongPress
  * @description - Hook that defines the logic when long pressing an element
  * @category Elements
+ * @usage medium
  *
  * @overload
  * @param {HookTarget} target The target element to be long pressed

package/dist/types/hooks/useMap/useMap.d.ts

@@ -19,6 +19,7 @@ export interface UseMapReturn<Key, Value> {
  * @name useMap
  * @description - Hook that manages a map structure
  * @category State
+ * @usage high
  *
  * @template Value The type of the value
  * @param {Value[]} [values] The initial array of the map

package/dist/types/hooks/useMeasure/useMeasure.d.ts

@@ -12,6 +12,7 @@ export interface UseMeasure {
  * @name useMeasure
  * @description - Hook to measure the size and position of an element
  * @category Browser
+ * @usage low
  *
  * @overload
  * @param {HookTarget} target The element to measure

package/dist/types/hooks/useMediaControls/useMediaControls.d.ts

@@ -65,6 +65,7 @@ export interface UseMediaControls {
  * @name useMediaControls
  * @description Hook that provides controls for HTML media elements (audio/video)
  * @category Browser
+ * @usage low
  *
  * @overload
  * @param {HookTarget} target The target media element

package/dist/types/hooks/useMediaQuery/useMediaQuery.d.ts

@@ -2,6 +2,7 @@
  * @name useMediaQuery
  * @description - Hook that manages a media query
  * @category Browser
+ * @usage medium
  *
  * @browserapi window.matchMedia https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia
  *

package/dist/types/hooks/useMemory/useMemory.d.ts

@@ -18,6 +18,7 @@ export interface UseMemoryReturn {
  * @name useMemory
  * @description - Hook that gives you current memory usage
  * @category Browser
+ * @usage low
  *
  * @browserapi performance.memory https://developer.mozilla.org/en-US/docs/Web/API/Performance/memory
  *

package/dist/types/hooks/useMergedRef/useMergedRef.d.ts

@@ -0,0 +1,17 @@
+import { Ref, RefCallback } from 'react';
+export declare const assignRef: <Element>(ref: Ref<Element>, value: Element) => ReturnType<RefCallback<Element>>;
+export declare const mergeRefs: <Element>(...refs: Ref<Element>[]) => RefCallback<Element>;
+/**
+ * @name useMergedRef
+ * @description - Hook that merges multiple refs into a single ref
+ * @category State
+ * @usage medium
+ *
+ * @template Element The element type
+ * @param {...Ref<Element>[]} refs The refs to merge
+ * @returns {RefCallback<Element>} A memoized ref callback that assigns to all provided refs
+ *
+ * @example
+ * const mergedRef = useMergedRef(firstRef, secondRef);
+ */
+export declare const useMergedRef: <Element>(...refs: Ref<Element>[]) => RefCallback<Element>;

package/dist/types/hooks/useMount/useMount.d.ts

@@ -3,6 +3,7 @@ import { EffectCallback } from 'react';
  * @name useMount
  * @description - Hook that executes a callback when the component mounts
  * @category Lifecycle
+ * @usage necessary
  *
  * @param {EffectCallback} effect The callback to execute
  *

package/dist/types/hooks/useMouse/useMouse.d.ts

@@ -30,6 +30,7 @@ export interface UseMouse {
  * @name useMouse
  * @description - Hook that manages a mouse position
  * @category Sensors
+ * @usage low
  *
  * @overload
  * @param {HookTarget} [target=window] The target element to manage the mouse position for

package/dist/types/hooks/useMutation/useMutation.d.ts

@@ -20,6 +20,7 @@ export interface RequestOptions<Data> extends UseMutationOptions<Data> {
  * @name useMutation
  * @description - Hook that defines the logic when mutate data
  * @category Async
+ * @usage high
  *
  * @template Body The type of the body
  * @template Data The type of the data

package/dist/types/hooks/useMutationObserver/useMutationObserver.d.ts

@@ -1,60 +1,77 @@
 import { HookTarget } from '../../utils/helpers';
 import { StateRef } from '../useRefState/useRefState';
-/** The mutation observer target element type */
-export type UseMutationObserverTarget = HookTarget;
-/** The mutation observer return type */
-export interface UseMutationObserverReturn {
-    /** The mutation observer instance */
-    observer: MutationObserver;
-    /** The mutation observer entries */
-    stop: () => void;
-}
+/** The mutation observer callback type */
+export type UseMutationObserverCallback = (mutations: MutationRecord[], observer: MutationObserver) => void;
 /** The mutation observer options type */
 export interface UseMutationObserverOptions extends MutationObserverInit {
     /** The enabled state of the mutation observer */
     enabled?: boolean;
+    /** The callback to execute when mutation is detected */
+    onChange?: UseMutationObserverCallback;
+}
+/** The mutation observer return type */
+export interface UseMutationObserverReturn {
+    /** The mutation observer instance */
+    observer?: MutationObserver;
 }
 export interface UseMutationObserver {
-    (target: HookTarget, callback: MutationCallback, options?: UseMutationObserverOptions): UseMutationObserverReturn;
-    <Target extends Element>(callback: MutationCallback, options?: UseMutationObserverOptions, target?: never): UseMutationObserverReturn & {
+    <Target extends Element>(options?: UseMutationObserverOptions, target?: never): UseMutationObserverReturn & {
+        ref: StateRef<Target>;
+    };
+    (target: HookTarget, options?: UseMutationObserverOptions): UseMutationObserverReturn;
+    <Target extends Element>(callback: UseMutationObserverCallback, target?: never): UseMutationObserverReturn & {
         ref: StateRef<Target>;
     };
+    (target: HookTarget, callback: UseMutationObserverCallback): UseMutationObserverReturn;
 }
 /**
  * @name useMutationObserver
  * @description - Hook that gives you mutation observer state
  * @category Sensors
+ * @usage low
+ *
+ * @browserapi MutationObserver https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver
  *
  * @overload
- * @template Target The target element
- * @param {MutationCallback} callback The callback to execute when mutation is detected
+ * @param {HookTarget} target The target element to observe
  * @param {boolean} [options.enabled=true] The enabled state of the mutation observer
+ * @param {UseMutationObserverCallback} [options.onChange] The callback to execute when mutation is detected
  * @param {boolean} [options.attributes] Set to true if mutations to target's attributes are to be observed
  * @param {boolean} [options.characterData] Set to true if mutations to target's data are to be observed
  * @param {boolean} [options.childList] Set to true if mutations to target's children are to be observed
- * @param {boolean} [options.subtree]  Set to true if mutations to not just target, but also target's descendants are to be observed
- * @param {boolean} [options.characterDataOldValue] Set to true if characterData is set to true or omitted and target's data before the mutation needs to be recorded
- * @param {boolean} [options.attributeOldValue]  Set to a list of attribute local names (without namespace) if not all attribute mutations need to be observed and attributes is true or omitted
- * @param {string[]} [options.attributeFilter] Set to a list of attribute local names (without namespace) if not all attribute mutations need to be observed and attributes is true or omitted
- * @returns {UseMutationObserverReturn & { ref: StateRef<Target> }} An object containing the mutation observer state
+ * @param {boolean} [options.subtree] Set to true if mutations to not just target, but also target's descendants are to be observed
+ * @returns {UseMutationObserverReturn} An object containing the mutation observer state
  *
  * @example
- * const { ref, observer, stop } = useMutationObserver(() => console.log('callback'))
+ * const { observer, stop } = useMutationObserver(ref, { childList: true });
  *
  * @overload
- * @param {HookTarget} target The target element to observe
- * @param {MutationCallback} callback The callback to execute when mutation is detected
+ * @template Target The target element
  * @param {boolean} [options.enabled=true] The enabled state of the mutation observer
+ * @param {UseMutationObserverCallback} [options.onChange] The callback to execute when mutation is detected
  * @param {boolean} [options.attributes] Set to true if mutations to target's attributes are to be observed
  * @param {boolean} [options.characterData] Set to true if mutations to target's data are to be observed
  * @param {boolean} [options.childList] Set to true if mutations to target's children are to be observed
- * @param {boolean} [options.subtree]  Set to true if mutations to not just target, but also target's descendants are to be observed
- * @param {boolean} [options.characterDataOldValue] Set to true if characterData is set to true or omitted and target's data before the mutation needs to be recorded
- * @param {boolean} [options.attributeOldValue]  Set to a list of attribute local names (without namespace) if not all attribute mutations need to be observed and attributes is true or omitted
- * @param {string[]} [options.attributeFilter] Set to a list of attribute local names (without namespace) if not all attribute mutations need to be observed and attributes is true or omitted
+ * @param {boolean} [options.subtree] Set to true if mutations to not just target, but also target's descendants are to be observed
+ * @returns {UseMutationObserverReturn & { ref: StateRef<Target> }} A React ref to attach to the target element
+ *
+ * @example
+ * const { ref, observer, stop } = useMutationObserver({ childList: true });
+ *
+ * @overload
+ * @template Target The target element
+ * @param {UseMutationObserverCallback} callback The callback to execute when mutation is detected
+ * @returns {UseMutationObserverReturn & { ref: StateRef<Target> }} A React ref to attach to the target element
+ *
+ * @example
+ * const { ref, observer, stop } = useMutationObserver((mutations) => console.log(mutations));
+ *
+ * @overload
+ * @param {UseMutationObserverCallback} callback The callback to execute when mutation is detected
+ * @param {HookTarget} target The target element to observe
  * @returns {UseMutationObserverReturn} An object containing the mutation observer state
  *
  * @example
- * const { observer, stop } = useMutationObserver(ref, () => console.log('callback'))
+ * const { observer, stop } = useMutationObserver((mutations) => console.log(mutations), ref);
  */
 export declare const useMutationObserver: UseMutationObserver;

package/dist/types/hooks/useNetwork/useNetwork.d.ts

@@ -40,6 +40,7 @@ export declare const getConnection: () => Connection;
  * @name useNetwork
  * @description - Hook to track network status
  * @category Browser
+ * @usage low
  *
  * @browserapi navigator.connection https://developer.mozilla.org/en-US/docs/Web/API/Navigator/connection
  *

package/dist/types/hooks/useObject/useObject.d.ts

@@ -0,0 +1,35 @@
+/** The use object return type */
+export interface UseObjectReturn<Value extends object> {
+    /** Checks if the object is empty */
+    empty: boolean;
+    /** Gets the keys of the object */
+    keys: Array<keyof Value>;
+    /** Gets the number of properties */
+    size: number;
+    /** The current object state */
+    value: Value;
+    /** Clears all properties from the object */
+    clear: () => void;
+    /** Checks if a property exists */
+    has: (key: keyof Value) => boolean;
+    /** Removes a property from the object */
+    remove: (key: keyof Value) => void;
+    /** Resets the object to its initial value */
+    reset: () => void;
+    /** Sets a property on the object */
+    set: (value: Partial<Value>) => void;
+}
+/**
+ * @name useObject
+ * @description - Hook that provides state and helper methods to manage an object
+ * @category State
+ * @usage medium
+ *
+ * @template Value The type of the object
+ * @param {Value} initialValue The initial object value
+ * @returns {UseObjectReturn<Value>} An object containing the current state and functions to interact with the object
+ *
+ * @example
+ * const { value, set, reset, remove, update, merge, clear, toggle, has, keys, isEmpty, size } = useObject({ name: 'John', age: 30, isActive: true });
+ */
+export declare function useObject<Value extends object>(initialValue: Value): UseObjectReturn<Value>;

package/dist/types/hooks/useOffsetPagination/useOffsetPagination.d.ts

@@ -3,29 +3,17 @@ export interface UseOffsetPaginationOptions {
     /** The initial page number */
     initialPage?: number;
     /** The number of items per page */
-    pageSize?: number;
+    initialPageSize?: number;
     /** The total number of items */
     total?: number;
     /** The callback function to be invoked when page changes */
-    onPageChange?: ({ page, pageSize }: {
-        page: number;
-        pageSize: number;
-    }) => void;
-    /** The callback function to be invoked when page count changes */
-    onPageCountChange?: ({ page, pageSize }: {
-        page: number;
-        pageSize: number;
-    }) => void;
-    /** The callback function to be invoked when page size changes */
-    onPageSizeChange?: ({ page, pageSize }: {
+    onChange?: ({ page, pageSize }: {
         page: number;
         pageSize: number;
     }) => void;
 }
 /** The use offset pagination return type */
 export interface UseOffsetPaginationReturn {
-    /** The number of items per page */
-    currentPageSize: number;
     /** Whether the current page is the first page */
     isFirstPage: boolean;
     /** Whether the current page is the last page */
@@ -34,35 +22,35 @@ export interface UseOffsetPaginationReturn {
     page: number;
     /** The total number of pages */
     pageCount: number;
+    /** The number of items per page */
+    pageSize: number;
     /** The callback function to go to the next page */
     next: () => void;
     /** The callback function to go to the previous page */
     prev: () => void;
     /** The callback function to set the current page */
-    set: (page: number) => void;
+    setPage: (page: number) => void;
+    /** The callback function to set the page size */
+    setPageSize: (pageSize: number) => void;
 }
 /**
  * @name useOffsetPagination
  * @description - Hook that defines the logic when pagination
  * @category State
+ * @usage medium
  *
  * @param {UseOffsetPaginationOptions} options - The options for the hook
  * @param {number} [options.total] - The total number of items
  * @param {number} [options.pageSize] - The number of items per page
  * @param {number} [options.initialPage] - The current page
- * @param {({ page, pageSize }: { page: number; pageSize: number }) => void} [options.onPageChange] - The callback function to be invoked when page changes
- * @param {({ page, pageSize }: { page: number; pageSize: number }) => void} [options.onPageCountChange] - The callback function to be invoked when page count changes
- * @param {({ page, pageSize }: { page: number; pageSize: number }) => void} [options.onPageSizeChange] - The callback function to be invoked when page size changes
+ * @param {({ page, pageSize }: { page: number; pageSize: number }) => void} [options.onChange] - The callback function to be invoked when page changes
  * @returns {UseOffsetPaginationReturn} - The state of the hook
  *
  * @example
  * const { currentPage, currentPageSize, pageCount, isFirstPage, isLastPage, prev, next } = useOffsetPagination({
  *  total: 100,
- *  pageSize: 10,
- *  page: 1,
- *  onPageChange: (page) => {},
- *  onPageCountChange: (pageCount) => {},
- *  onPageSizeChange: (pageSize) => {}
+ *  initialPageSize: 10,
+ *  initialPage: 1
  * });
  */
-export declare const useOffsetPagination: ({ total, pageSize, initialPage, onPageChange, onPageCountChange, onPageSizeChange }?: UseOffsetPaginationOptions) => UseOffsetPaginationReturn;
+export declare const useOffsetPagination: ({ total, initialPage, initialPageSize, onChange }?: UseOffsetPaginationOptions) => UseOffsetPaginationReturn;

package/dist/types/hooks/useOnce/useOnce.d.ts

@@ -3,6 +3,7 @@ import { EffectCallback } from 'react';
  * @name useEffectOnce
  * @description - Hook that runs an effect only once. Please do not use it in production code!
  * @category Humor
+ * @usage low
  *
  * @warning - This hook will run effect only once even in strict mode. Please do not use it in production code!
  *

package/dist/types/hooks/useOnline/useOnline.d.ts

@@ -2,6 +2,7 @@
  * @name useOnline
  * @description - Hook that manages if the user is online
  * @category Browser
+ * @usage medium
  *
  * @browserapi navigator.onLine https://developer.mozilla.org/en-US/docs/Web/API/Navigator/onLine
  *

package/dist/types/hooks/useOperatingSystem/useOperatingSystem.d.ts

@@ -5,6 +5,7 @@ export declare const getOperatingSystem: () => OperatingSystem;
  * @name useOperatingSystem
  * @description - Hook that returns the operating system of the current browser
  * @category User
+ * @usage low
  *
  * @returns {OperatingSystem} The operating system
  *

package/dist/types/hooks/useOptimistic/useOptimistic.d.ts

@@ -6,6 +6,7 @@ export type UseOptimisticReturn<State> = [
  * @name useOptimistic
  * @description - Hook that allows get optimistic value before its update
  * @category Async
+ * @usage medium
  *
  * @template State The type of the state
  * @param {State} state The value to be returned initially and whenever no action is pending

package/dist/types/hooks/useOrientation/useOrientation.d.ts

@@ -7,7 +7,7 @@ export interface UseOrientationValue {
     /** The current angle */
     angle: number;
     /** The current orientation type */
-    orientationType: OrientationType;
+    orientationType?: OrientationType;
 }
 export type OrientationLockType = 'any' | 'landscape-primary' | 'landscape-secondary' | 'landscape' | 'natural' | 'portrait-primary' | 'portrait-secondary' | 'portrait';
 export interface useOrientationReturn {
@@ -24,6 +24,7 @@ export interface useOrientationReturn {
  * @name useOrientation
  * @description - Hook that provides the current screen orientation
  * @category Sensors
+ * @usage low
  *
  * @browserapi screen.orientation https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation
  *

package/dist/types/hooks/useOtpCredential/useOtpCredential.d.ts

@@ -28,6 +28,7 @@ export interface UseOtpCredential {
  * @name useOtpCredential
  * @description - Hook that creates an otp credential
  * @category Browser
+ * @usage low
  *
  * @browserapi navigator.credentials https://developer.mozilla.org/en-US/docs/Web/API/Navigator/credentials
  *

package/dist/types/hooks/usePageLeave/usePageLeave.d.ts

@@ -2,6 +2,7 @@
  * @name usePageLeave
  * @description - Hook what calls given function when mouse leaves the page
  * @category Sensors
+ * @usage low
  *
  * @param {() => void} [callback] The callback function what calls then mouse leaves the page
  * @returns {boolean} A boolean which determines if the mouse left the page

package/dist/types/hooks/usePaint/usePaint.d.ts

@@ -78,6 +78,7 @@ export interface UsePaint {
  * @name usePaint
  * @description - Hook that allows you to draw in a specific area
  * @category Elements
+ * @usage low
  *
  * @overload
  * @param {HookTarget} target The target element to be painted

package/dist/types/hooks/useParallax/useParallax.d.ts

@@ -33,6 +33,7 @@ export interface UseParallax {
  * @name useParallax
  * @description - Hook to help create parallax effect
  * @category Sensors
+ * @usage low
  *
  * @overload
  * @param {HookTarget} target The target element for the parallax effect