@siberiacancode/reactuse 0.2.28 → 0.2.30

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

@@ -7,6 +7,7 @@ export type UsePerformanceObserverOptions = PerformanceObserverInit & {
  * @name usePerformanceObserver
  * @description - Hook that allows you to observe performance entries
  * @category Sensors
+ * @usage low
  *
  * @browserapi PerformanceObserver https://developer.mozilla.org/en-US/docs/Web/API/PerformanceObserver
  *

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

@@ -18,6 +18,7 @@ export interface UsePermissionReturn {
  *  @name usePermission
  *  @description - Hook that gives you the state of permission
  *  @category Browser
+ *  @usage medium
  *
  *  @browserapi navigator.permissions https://developer.mozilla.org/en-US/docs/Web/API/Navigator/permissions
  *

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

@@ -30,6 +30,7 @@ export interface UsePictureInPicture {
  * @name usePictureInPicture
  * @description - Hook that provides Picture-in-Picture functionality for video elements
  * @category Browser
+ * @usage low
  *
  * @browserapi window.PictureInPicture https://developer.mozilla.org/en-US/docs/Web/API/Picture-in-Picture_API
  *

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

@@ -14,6 +14,7 @@ interface UsePointerLockReturn {
  * @name usePointerLock
  * @description - Hook that provides reactive pointer lock
  * @category Browser
+ * @usage low
  *
  * @browserapi pointerLockElement https://developer.mozilla.org/en-US/docs/Web/API/Document/pointerLockElement
  *

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

@@ -3,6 +3,7 @@ export type UsePostMessageReturn<Message> = (message: Message) => void;
  * @name usePostMessage
  * @description - Hook that allows you to receive messages from other origins
  * @category Browser
+ * @usage low
  *
  * @overload
  * @template Message The message data type

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

@@ -4,6 +4,7 @@ export type UsePreferredColorSchemeReturn = 'dark' | 'light' | 'no-preference';
  * @name usePreferredColorScheme
  * @description - Hook that returns user preferred color scheme
  * @category User
+ * @usage medium
  *
  * @returns {UsePreferredColorSchemeReturn} String of preferred color scheme
  *

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

@@ -4,6 +4,7 @@ export type UsePreferredContrastReturn = 'custom' | 'less' | 'more' | 'no-prefer
  * @name usePreferredContrast
  * @description - Hook that returns the contrast preference
  * @category User
+ * @usage medium
  *
  * @returns {UsePreferredContrastReturn} The contrast preference
  *

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

@@ -2,6 +2,7 @@
  * @name usePreferredDark
  * @description - Hook that returns if the user prefers dark mode
  * @category User
+ * @usage medium
  *
  * @example
  * const isDark = usePreferredDark();

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

@@ -2,6 +2,7 @@
  * @name usePreferredLanguages
  * @description Hook that returns a browser preferred languages from navigator
  * @category User
+ * @usage medium
  *
  * @browserapi navigator.languages https://developer.mozilla.org/en-US/docs/Web/API/Navigator/languages
  *

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

@@ -4,6 +4,7 @@ export type UsePreferredReducedMotionReturn = 'no-preference' | 'reduce';
  * @name usePreferredReducedMotion
  * @description - Hook that returns the reduced motion preference
  * @category User
+ * @usage low
  *
  * @returns {UsePreferredReducedMotionReturn} The reduced motion preference
  *

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

@@ -5,6 +5,7 @@ export interface UsePreviousOptions<Value> {
  * @name usePrevious
  * @description - Hook that returns the previous value
  * @category Utilities
+ * @usage low
  *
  * @template Value The type of the value
  * @param {Value} value The value to get the previous value

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

@@ -29,6 +29,7 @@ export interface UseQueryReturn<Data> {
  * @name useQuery
  * @description - Hook that defines the logic when query data
  * @category Async
+ * @usage high
  *
  * @template Data The type of the data
  * @param {() => Promise<Data>} callback The callback function to be invoked

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

@@ -19,6 +19,7 @@ export interface UseQueueReturn<Value> {
  * @name useQueue
  * @description - Hook that manages a queue
  * @category State
+ * @usage medium
  *
  * @template Value The type of the value
  * @param {Value[]} [initialValue=[]] The initial value of the queue

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

@@ -23,6 +23,7 @@ export interface UseRafReturn {
  * @name useRaf
  * @description - Hook that defines the logic for raf callback
  * @category Browser
+ * @usage low
  *
  * @browserapi requestAnimationFrame https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  *

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

@@ -3,6 +3,9 @@ export type UseRafStateReturn<Value> = [Value, (value: Value) => void];
  * @name useRafState
  * @description - Hook that returns the value and a function to set the value
  * @category State
+ * @usage low
+ *
+ * @browserapi requestAnimationFrame https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  *
  * @template Value The type of the value
  * @param {Value} initialValue The initial value

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

@@ -7,6 +7,7 @@ export interface StateRef<Value> {
  * @name useRefState
  * @description - Hook that returns the state reference of the value
  * @category State
+ * @usage low
  *
  * @template Value The type of the value
  * @param {Value} [initialValue] The initial value

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

@@ -2,6 +2,7 @@
  * @name useRenderCount
  * @description - Hook returns count component render times
  * @category Debug
+ * @usage low
  *
  * @returns {number} A number which determines how many times component renders
  *

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

@@ -13,6 +13,7 @@ export interface UseRenderInfoReturn {
  * @name useRenderInfo
  * @description - Hook for getting information about component rerender
  * @category Debug
+ * @usage low
  *
  * @param {string} [name='Unknown'] Component name
  * @param {boolean} [log=true] Toggle logging

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

@@ -4,6 +4,7 @@ type UseRerenderReturn = () => void;
  * @name useRerender
  * @description - Hook that defines the logic to force rerender a component
  * @category Debug
+ * @usage medium
  *
  * @returns {UseRerenderReturn} The rerender function
  *

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

@@ -1,49 +1,73 @@
 import { HookTarget } from '../../utils/helpers';
 import { StateRef } from '../useRefState/useRefState';
+/** The resize observer callback type */
+export type UseResizeObserverCallback = (entry: ResizeObserverEntry, observer: ResizeObserver) => void;
 /** The resize observer options type */
 export interface UseResizeObserverOptions extends ResizeObserverOptions {
-    /** The enabled state */
+    /** The enabled state of the resize observer */
     enabled?: boolean;
-    /** The resize observer callback */
-    onChange?: (entries: ResizeObserverEntry[], observer: ResizeObserver) => void;
+    /** The callback to execute when resize is detected */
+    onChange?: UseResizeObserverCallback;
 }
 /** The resize observer return type */
 export interface UseResizeObserverReturn {
     /** The resize observer entries */
-    entries: ResizeObserverEntry[];
+    entry: ResizeObserverEntry;
+    /** The resize observer instance */
+    observer?: ResizeObserver;
 }
 export interface UseResizeObserver {
-    (target: HookTarget, options?: UseResizeObserverOptions): UseResizeObserverReturn;
     <Target extends Element>(options?: UseResizeObserverOptions, target?: never): UseResizeObserverReturn & {
         ref: StateRef<Target>;
     };
+    (target: HookTarget, options?: UseResizeObserverOptions): UseResizeObserverReturn;
+    <Target extends Element>(callback: UseResizeObserverCallback, target?: never): UseResizeObserverReturn & {
+        ref: StateRef<Target>;
+    };
+    (target: HookTarget, callback: UseResizeObserverCallback): UseResizeObserverReturn;
 }
 /**
- *  @name useResizeObserver
- *  @description - Hook that gives you resize observer state
- *  @category Sensors
- *
- *  @browserapi ResizeObserver https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver
- *
- *  @overload
- *  @template Target The target element
- *  @param {boolean} [options.enabled=true] The IntersectionObserver options
- *  @param {boolean} [options.box] The IntersectionObserver options
- *  @param {(entries: ResizeObserverEntry[], observer: ResizeObserver) => void} [options.onChange] The callback to execute when resize is detected
- *  @returns {UseResizeObserverReturn & { ref: StateRef<Target> }} An object containing the resize observer state
- *
- *  @example
- *  const { ref, entries } = useResizeObserver();
- *
- *  @overload
- *  @template Target The target element
- *  @param {HookTarget} target The target element to observe
- *  @param {boolean} [options.enabled=true] The IntersectionObserver options
- *  @param {boolean} [options.box] The IntersectionObserver options
- *  @param {(entries: ResizeObserverEntry[], observer: ResizeObserver) => void} [options.onChange] The callback to execute when resize is detected
- *  @returns {UseResizeObserverReturn} An object containing the resize observer state
- *
- *  @example
- *  const { entries } = useResizeObserver(ref);
+ * @name useResizeObserver
+ * @description - Hook that gives you resize observer state
+ * @category Sensors
+ * @usage low
+ *
+ * @browserapi ResizeObserver https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver
+ *
+ * @overload
+ * @param {HookTarget} target The target element to observe
+ * @param {boolean} [options.enabled=true] The enabled state of the resize observer
+ * @param {ResizeObserverBoxOptions} [options.box] The box model to observe
+ * @param {UseResizeObserverCallback} [options.onChange] The callback to execute when resize is detected
+ * @returns {UseResizeObserverReturn} An object containing the resize observer state
+ *
+ * @example
+ * const { entries, observer } = useResizeObserver(ref);
+ *
+ * @overload
+ * @template Target The target element
+ * @param {boolean} [options.enabled=true] The enabled state of the resize observer
+ * @param {ResizeObserverBoxOptions} [options.box] The box model to observe
+ * @param {UseResizeObserverCallback} [options.onChange] The callback to execute when resize is detected
+ * @returns {UseResizeObserverReturn & { ref: StateRef<Target> }} A React ref to attach to the target element
+ *
+ * @example
+ * const { ref, entry, observer } = useResizeObserver();
+ *
+ * @overload
+ * @template Target The target element
+ * @param {UseResizeObserverCallback} callback The callback to execute when resize is detected
+ * @returns {UseResizeObserverReturn & { ref: StateRef<Target> }} A React ref to attach to the target element
+ *
+ * @example
+ * const { ref, entry, observer } = useResizeObserver((entry) => console.log(entry));
+ *
+ * @overload
+ * @param {HookTarget} target The target element to observe
+ * @param {UseResizeObserverCallback} callback The callback to execute when resize is detected
+ * @returns {UseResizeObserverReturn} An object containing the resize observer state
+ *
+ * @example
+ * const { entry, observer } = useResizeObserver(ref, (entry) => console.log(entry));
  */
 export declare const useResizeObserver: UseResizeObserver;

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

@@ -17,6 +17,7 @@ export interface UseRightClick {
  * @name useRightClick
  * @description - Hook that handles right-click events and long press on mobile devices
  * @category Elements
+ * @usage low
  *
  * @overload
  * @param {HookTarget} target The target element for right-click handling

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

@@ -11,6 +11,7 @@ export interface UseScriptOptions extends ComponentProps<'script'> {
  * @name useScript
  * @description - Hook that manages a script with onLoad, onError, and removeOnUnmount functionalities
  * @category Elements
+ * @usage low
  *
  * @param {string} src The source of the script
  * @param {UseScriptOptions} [options] The options of the script extends from attributes script tag

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

@@ -49,6 +49,7 @@ export interface UseScroll {
  * @name useScroll
  * @description - Hook that allows you to control scroll a element
  * @category Sensors
+ * @usage low
  *
  * @overload
  * @template Target The target element

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

@@ -24,6 +24,7 @@ export interface UseScrollIntoView {
  * @name useScrollIntoView
  * @description - Hook that provides functionality to scroll an element into view
  * @category Sensors
+ * @usage low
  *
  * @overload
  * @param {HookTarget} target The target element to scroll into view

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

@@ -30,6 +30,7 @@ export interface UseScrollTo {
  * @name useScrollTo
  * @description - Hook for scrolling to a specific element
  * @category Sensors
+ * @usage low
  *
  * @overload
  * @param {HookTarget} target The target element for scrolling to

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

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

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

@@ -29,6 +29,7 @@ interface UseSetReturn<Value> {
  * @name useSet
  * @description - Hook that manages a set structure
  * @category State
+ * @usage medium
  *
  * @template Value The type of the value
  * @param {Value[]} [values] The initial array of the set

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

@@ -4,6 +4,7 @@ export declare const deepEqual: (a: any, b: any) => boolean;
  * @name useShallowEffect
  * @description - Hook that executes an effect only when dependencies change shallowly or deeply
  * @category Lifecycle
+ * @usage low
  *
  * @param {EffectCallback} effect The effect callback
  * @param {DependencyList} [deps] The dependencies list for the effect

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

@@ -20,6 +20,7 @@ export interface UseShareReturn {
  * @name useShare
  * @description - Hook that utilizes the share api
  * @category Browser
+ * @usage medium
  *
  * @browserapi share https://developer.mozilla.org/en-US/docs/Web/API/Navigator/share
  *

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

@@ -48,6 +48,7 @@ export declare const getSpeechRecognition: () => {
  * @name useSpeechRecognition
  * @description - Hook that provides a streamlined interface for incorporating speech-to-text functionality
  * @category Browser
+ * @usage low
  *
  * @browserapi window.SpeechRecognition https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition
  *

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

@@ -42,6 +42,7 @@ export interface UseSpeechSynthesisReturn {
  * @name useSpeechSynthesis
  * @description - Hook that provides speech synthesis functionality
  * @category Browser
+ * @usage low
  *
  * @browserapi SpeechSynthesis https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis
  *

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

@@ -61,6 +61,7 @@ export declare const stateHistoryReducer: <Value>(state: StateHistory<Value>, ac
  * @name useStateHistory
  * @description - Hook that manages state with history functionality
  * @category State
+ * @usage medium
  *
  * @param {Value} initialValue - The initial value to start the history with
  * @param {number} [capacity=10] - Maximum number of history entries and undo actions to keep

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

@@ -28,6 +28,7 @@ export interface UseStepReturn {
  * @name useStep
  * @description - Hook that create stepper
  * @category State
+ * @usage medium
  *
  * @overload
  * @param {number} max Maximum number of steps

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

@@ -21,6 +21,7 @@ export interface UseSticky {
  * @name UseSticky
  * @description - Hook that allows you to detect that your sticky component is stuck
  * @category Elements
+ * @usage low
  *
  * @overload
  * @param {HookTarget} target The target sticky element

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

@@ -38,6 +38,7 @@ interface UseStopwatch {
  * @name useStopwatch
  * @description - Hook that creates a stopwatch functionality
  * @category Time
+ * @usage high
  *
  * @overload
  * @param {number} [initialTime=0] The initial time of the timer

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

@@ -20,6 +20,7 @@ export declare const dispatchStorageEvent: (params: Partial<StorageEvent>) => bo
  * @name useStorage
  * @description - Hook that manages storage value
  * @category State
+ * @usage high
  *
  * @overload
  * @param {string} key The key of the storage

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

@@ -21,6 +21,7 @@ export interface UseTextDirection {
  * @name useTextDirection
  * @description - Hook that can get and set the direction of the element
  * @category Elements
+ * @usage medium
  *
  * @overload
  * @param {HookTarget} [target=document.querySelector('html')] The target element to observe

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

@@ -14,6 +14,7 @@ export interface UseTextSelectionReturn {
  * @name useTextSelection
  * @description - Hook that manages the text selection
  * @category Sensors
+ * @usage low
  *
  * @browserapi document.getSelection https://developer.mozilla.org/en-US/docs/Web/API/Document/getSelection
  *

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

@@ -5,6 +5,7 @@ export type ThrottledCallback<Params extends unknown[]> = ((...args: Params) =>
  * @name useThrottleCallback
  * @description - Hook that creates a throttled callback
  * @category Utilities
+ * @usage medium
  *
  * @template Params The type of the params
  * @template Return The type of the return

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

@@ -0,0 +1,15 @@
+/**
+ * @name useThrottleState
+ * @description - Hook that creates a throttled state
+ * @category Utilities
+ * @usage medium
+ *
+ * @template Value The type of the value
+ * @param {Value} value The value to be throttled
+ * @param {number} delay The delay in milliseconds
+ * @returns {[Value, (value: Value) => void]} The throttled state
+ *
+ * @example
+ * const [throttledValue, setThrottledValue] = useThrottleState(value, 500);
+ */
+export declare const useThrottleState: <Value>(initialValue: Value, delay: number) => readonly [Value, import('..').ThrottledCallback<[value: import('react').SetStateAction<Value>]>];

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

@@ -2,6 +2,7 @@
  * @name useThrottleValue
  * @description - Hook that creates a throttled value
  * @category Utilities
+ * @usage medium
  *
  * @template Value The type of the value
  * @param {Value} value The value to be throttled

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

@@ -23,6 +23,7 @@ export interface UseTimeReturn {
  * @name useTime
  * @description - Hook that gives you current time in different values
  * @category Time
+ * @usage medium
  *
  * @returns {UseTimeReturn} An object containing the current time
  *

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

@@ -9,6 +9,7 @@ interface UseTimeoutReturn {
  * @name useTimeout
  * @description - Hook that executes a callback function after a specified delay
  * @category Time
+ * @usage medium
  *
  * @param {() => void} callback The function to be executed after the timeout
  * @param {number} delay The delay in milliseconds before the timeout executes the callback function

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

@@ -56,6 +56,7 @@ export interface UseTimer {
  * @name useTimer
  * @description - Hook that creates a timer functionality
  * @category Time
+ * @usage medium
  *
  * @overload
  * @returns {UseTimerReturn} An object containing the timer properties and functions

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

@@ -5,6 +5,7 @@ export type UseToggleReturn<Value> = readonly [Value, (value?: Value) => void];
  * @name useToggle
  * @description - Hook that create toggle
  * @category State
+ * @usage high
  *
  * @template Value The type of the value
  * @param {Value[]} [values=[false, true]] The values to toggle

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

@@ -2,6 +2,7 @@
  * @name useUnmount
  * @description - Hook that defines the logic when unmounting a component
  * @category Lifecycle
+ * @usage necessary
  *
  * @param {() => void} callback The callback function to be invoked on component unmount
  * @returns {void}

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

@@ -43,6 +43,7 @@ export interface UseUrlSearchParam {
  * @name useUrlSearchParam
  * @description - Hook that provides reactive URLSearchParams for a single key
  * @category State
+ * @usage high
  *
  * @overload
  * @template Value The type of the url param values

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

@@ -38,6 +38,7 @@ export interface UseUrlSearchParams {
  * @name useUrlSearchParams
  * @description - Hook that provides reactive URLSearchParams
  * @category State
+ * @usage high
  *
  * @overload
  * @template Value The type of the url param values

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

@@ -19,6 +19,7 @@ export interface UseVibrateReturn {
  * @name useVibrate
  * @description - Hook that provides vibrate api
  * @category Browser
+ * @usage low
  *
  * @browserapi navigator.vibrate https://developer.mozilla.org/en-US/docs/Web/API/Navigator/vibrate
  *

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

@@ -27,6 +27,7 @@ export interface UseVirtualKeyboardReturn {
  * @name useVirtualKeyboard
  * @description - Hook that manages virtual keyboard state
  * @category Browser
+ * @usage low
  *
  * @browserapi VirtualKeyboard https://developer.mozilla.org/en-US/docs/Web/API/VirtualKeyboard
  *

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

@@ -20,6 +20,7 @@ export interface UseWakeLockReturn {
  * @name useWakeLock
  * @description - Hook that provides a wake lock functionality
  * @category Browser
+ * @usage low
  *
  * @browserapi navigator.wakeLock https://developer.mozilla.org/en-US/docs/Web/API/WakeLock
  *

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

@@ -1,24 +1,41 @@
+/** The use web socket url type */
 export type UseWebSocketUrl = (() => string) | string;
+/** The use web socket options type */
 export interface UseWebSocketOptions {
+    /** The list of protocols to use */
     protocols?: Array<'soap' | 'wasm'>;
+    /** The number of times to retry the connection */
     retry?: boolean | number;
+    /** The callback function that is called when the WebSocket connection is established */
     onConnected?: (webSocket: WebSocket) => void;
+    /** The callback function that is called when the WebSocket connection is closed */
     onDisconnected?: (event: CloseEvent, webSocket: WebSocket) => void;
+    /** The callback function that is called when an error occurs */
     onError?: (event: Event, webSocket: WebSocket) => void;
+    /** The callback function that is called when a message is received */
     onMessage?: (event: MessageEvent, webSocket: WebSocket) => void;
 }
 export type UseWebSocketStatus = 'connected' | 'connecting' | 'disconnected' | 'failed';
+/** The use web socket return type */
 export interface UseWebSocketReturn {
+    /** The WebSocket client */
     client?: WebSocket;
+    /** The close function */
     close: WebSocket['close'];
+    /** The send function */
     send: WebSocket['send'];
+    /** The status of the WebSocket connection */
     status: UseWebSocketStatus;
+    /** The open function */
     open: () => void;
 }
 /**
  * @name useWebSocket
  * @description - Hook that connects to a WebSocket server and handles incoming and outgoing messages
  * @category Browser
+ * @usage medium
+ *
+ * @browserapi WebSocket https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
  *
  * @param {UseWebSocketUrl} url The URL of the WebSocket server
  * @param {(webSocket: WebSocket) => void} [options.onConnected] The callback function that is called when the WebSocket connection is established

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

@@ -3,6 +3,7 @@ import { UseEventListenerOptions } from '../useEventListener/useEventListener';
  * @name useWindowEvent
  * @description - Hook attaches an event listener to the window object for the specified event
  * @category Sensors
+ * @usage low
  *
  * @template Event Key of window event map.
  * @param {Event} event The event to listen for.

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

@@ -2,6 +2,7 @@
  * @name useWindowFocus
  * @description - Hook that provides the current focus state of the window
  * @category Elements
+ * @usage low
  *
  * @returns {boolean} The current focus state of the window
  *