main 🧊 add usage badge for helpers

debabin · debabin · commit 25449ece842f · 2025-08-14T12:41:57.000+07:00
diff --git a/packages/core/src/bundle/helpers/createContext/createContext.js b/packages/core/src/bundle/helpers/createContext/createContext.js
@@ -4,6 +4,7 @@ import { createContext as createReactContext, useContext, useMemo, useState } fr
  * @name createContext
  * @description - Creates a typed context with additional utilities
  * @category Helpers
+ * @usage high
  *
  * @template Value - The type of value that will be stored in the context
  * @param {Value | undefined} [defaultValue] - Default value for the context
diff --git a/packages/core/src/bundle/helpers/createEventEmitter/createEventEmitter.js b/packages/core/src/bundle/helpers/createEventEmitter/createEventEmitter.js
@@ -3,6 +3,7 @@ import { useEffect, useRef, useState } from 'react';
  * @name createEventEmitter
  * @description - Creates a type-safe event emitter
  * @category Helpers
+ * @usage low
  *
  * @template Events - The type of events and their data
  * @returns {EventEmitterApi<Events>} - Object containing event emitter methods and hook
diff --git a/packages/core/src/bundle/helpers/createReactiveContext/createReactiveContext.js b/packages/core/src/bundle/helpers/createReactiveContext/createReactiveContext.js
@@ -61,6 +61,7 @@ const createReactiveContextSelector = (Context, selector, options = {}) => {
  * @name createReactiveContext
  * @description - Creates a typed context selector with optimized updates for state selection
  * @category Helpers
+ * @usage low
  *
  * @warning - For complex interfaces, we strongly recommend using state management solutions outside of React like createStore, reatom, effector, or zustand instead of context
  *
diff --git a/packages/core/src/bundle/helpers/createStore/createStore.js b/packages/core/src/bundle/helpers/createStore/createStore.js
@@ -3,6 +3,7 @@ import { useSyncExternalStore } from 'react';
  * @name createStore
  * @description - Creates a store with state management capabilities
  * @category Helpers
+ * @usage medium
  *
  * @template Value - The type of the store state
  * @param {StateCreator<Value>} createState - Function that initializes the store state
diff --git a/packages/core/src/bundle/hooks/useKeysPressed/useKeysPressed.js b/packages/core/src/bundle/hooks/useKeysPressed/useKeysPressed.js
@@ -2,8 +2,6 @@ import { useEffect, useState } from 'react';
 import { getElement, isTarget } from '@/utils/helpers';
 import { useRefState } from '../useRefState/useRefState';
 /**
- * Hook that tracks which keyboard keys are currently pressed
- *
  * @name useKeysPressed
  * @description Tracks all currently pressed keyboard keys and their codes
  * @category Sensors
diff --git a/packages/core/src/bundle/hooks/useLastChanged/useLastChanged.js b/packages/core/src/bundle/hooks/useLastChanged/useLastChanged.js
@@ -5,6 +5,7 @@ import { useDidUpdate } from '../useDidUpdate/useDidUpdate';
  * @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
  * @returns {number | null} Return timestamp of the last change
diff --git a/packages/core/src/bundle/hooks/useMediaQuery/useMediaQuery.js b/packages/core/src/bundle/hooks/useMediaQuery/useMediaQuery.js
@@ -5,6 +5,7 @@ const getServerSnapshot = () => false;
  * @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
  *
  * @param {string} query The media query string
diff --git a/packages/core/src/bundle/hooks/useVirtualKeyboard/useVirtualKeyboard.js b/packages/core/src/bundle/hooks/useVirtualKeyboard/useVirtualKeyboard.js
@@ -3,6 +3,7 @@ import { useEffect, useState } from 'react';
  * @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
  *
diff --git a/packages/core/src/helpers/createContext/createContext.tsx b/packages/core/src/helpers/createContext/createContext.tsx
@@ -43,6 +43,7 @@ export interface CreateContextReturn<Value> {
  * @name createContext
  * @description - Creates a typed context with additional utilities
  * @category Helpers
+ * @usage high
  *
  * @template Value - The type of value that will be stored in the context
  * @param {Value | undefined} [defaultValue] - Default value for the context
diff --git a/packages/core/src/helpers/createEventEmitter/createEventEmitter.ts b/packages/core/src/helpers/createEventEmitter/createEventEmitter.ts
@@ -4,6 +4,7 @@ import { useEffect, useRef, useState } from 'react';
  * @name createEventEmitter
  * @description - Creates a type-safe event emitter
  * @category Helpers
+ * @usage low
  *
  * @template Events - The type of events and their data
  * @returns {EventEmitterApi<Events>} - Object containing event emitter methods and hook
diff --git a/packages/core/src/helpers/createReactiveContext/createReactiveContext.ts b/packages/core/src/helpers/createReactiveContext/createReactiveContext.ts
@@ -109,6 +109,7 @@ const createReactiveContextSelector = <Value, Selected>(
  * @name createReactiveContext
  * @description - Creates a typed context selector with optimized updates for state selection
  * @category Helpers
+ * @usage low
  *
  * @warning - For complex interfaces, we strongly recommend using state management solutions outside of React like createStore, reatom, effector, or zustand instead of context
  *
diff --git a/packages/core/src/helpers/createStore/createStore.ts b/packages/core/src/helpers/createStore/createStore.ts
@@ -20,6 +20,7 @@ export interface StoreApi<Value> {
  * @name createStore
  * @description - Creates a store with state management capabilities
  * @category Helpers
+ * @usage medium
  *
  * @template Value - The type of the store state
  * @param {StateCreator<Value>} createState - Function that initializes the store state
diff --git a/packages/core/src/hooks/useKeysPressed/useKeysPressed.ts b/packages/core/src/hooks/useKeysPressed/useKeysPressed.ts
@@ -32,8 +32,6 @@ 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
diff --git a/packages/core/src/hooks/useLastChanged/useLastChanged.ts b/packages/core/src/hooks/useLastChanged/useLastChanged.ts
@@ -12,6 +12,7 @@ export interface UseLastChangedOptions {
  * @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
  * @returns {number | null} Return timestamp of the last change
diff --git a/packages/core/src/hooks/useLocalStorage/useLocalStorage.demo.tsx b/packages/core/src/hooks/useLocalStorage/useLocalStorage.demo.tsx
@@ -1,7 +1,9 @@
 import { useLocalStorage } from '@siberiacancode/reactuse';
 
 const Demo = () => {
-  const { value, set, remove } = useLocalStorage('siberiacancode-use-local-storage', 0);
+  const { value, set, remove } = useLocalStorage('siberiacancode-use-local-storage', 5);
+
+  console.log(value);
 
   return (
     <div>
diff --git a/packages/core/src/hooks/useMediaQuery/useMediaQuery.ts b/packages/core/src/hooks/useMediaQuery/useMediaQuery.ts
@@ -7,6 +7,7 @@ const getServerSnapshot = () => false;
  * @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
  *
  * @param {string} query The media query string
diff --git a/packages/core/src/hooks/useVirtualKeyboard/useVirtualKeyboard.ts b/packages/core/src/hooks/useVirtualKeyboard/useVirtualKeyboard.ts
@@ -31,6 +31,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
  *

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import { createContext as createReactContext, useContext, useMemo, useState } fr`
`4`	`4`	`* @name createContext`
`5`	`5`	`* @description - Creates a typed context with additional utilities`
`6`	`6`	`* @category Helpers`
	`7`	`+ * @usage high`
`7`	`8`	`*`
`8`	`9`	`* @template Value - The type of value that will be stored in the context`
`9`	`10`	`* @param {Value \| undefined} [defaultValue] - Default value for the context`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ import { useEffect, useRef, useState } from 'react';`
`3`	`3`	`* @name createEventEmitter`
`4`	`4`	`* @description - Creates a type-safe event emitter`
`5`	`5`	`* @category Helpers`
	`6`	`+ * @usage low`
`6`	`7`	`*`
`7`	`8`	`* @template Events - The type of events and their data`
`8`	`9`	`* @returns {EventEmitterApi<Events>} - Object containing event emitter methods and hook`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ const createReactiveContextSelector = (Context, selector, options = {}) => {`
`61`	`61`	`* @name createReactiveContext`
`62`	`62`	`* @description - Creates a typed context selector with optimized updates for state selection`
`63`	`63`	`* @category Helpers`
	`64`	`+ * @usage low`
`64`	`65`	`*`
`65`	`66`	`* @warning - For complex interfaces, we strongly recommend using state management solutions outside of React like createStore, reatom, effector, or zustand instead of context`
`66`	`67`	`*`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ import { useSyncExternalStore } from 'react';`
`3`	`3`	`* @name createStore`
`4`	`4`	`* @description - Creates a store with state management capabilities`
`5`	`5`	`* @category Helpers`
	`6`	`+ * @usage medium`
`6`	`7`	`*`
`7`	`8`	`* @template Value - The type of the store state`
`8`	`9`	`* @param {StateCreator<Value>} createState - Function that initializes the store state`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ const getServerSnapshot = () => false;`
`5`	`5`	`* @description - Hook that manages a media query`
`6`	`6`	`* @category Browser`
`7`	`7`	`* @usage medium`
	`8`	`+ *`
`8`	`9`	`* @browserapi window.matchMedia https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia`
`9`	`10`	`*`
`10`	`11`	`* @param {string} query The media query string`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ import { useEffect, useState } from 'react';`
`3`	`3`	`* @name useVirtualKeyboard`
`4`	`4`	`* @description - Hook that manages virtual keyboard state`
`5`	`5`	`* @category Browser`
	`6`	`+ * @usage low`
`6`	`7`	`*`
`7`	`8`	`* @browserapi VirtualKeyboard https://developer.mozilla.org/en-US/docs/Web/API/VirtualKeyboard`
`8`	`9`	`*`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ export interface CreateContextReturn<Value> {`
`43`	`43`	`* @name createContext`
`44`	`44`	`* @description - Creates a typed context with additional utilities`
`45`	`45`	`* @category Helpers`
	`46`	`+ * @usage high`
`46`	`47`	`*`
`47`	`48`	`* @template Value - The type of value that will be stored in the context`
`48`	`49`	`* @param {Value \| undefined} [defaultValue] - Default value for the context`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import { useEffect, useRef, useState } from 'react';`
`4`	`4`	`* @name createEventEmitter`
`5`	`5`	`* @description - Creates a type-safe event emitter`
`6`	`6`	`* @category Helpers`
	`7`	`+ * @usage low`
`7`	`8`	`*`
`8`	`9`	`* @template Events - The type of events and their data`
`9`	`10`	`* @returns {EventEmitterApi<Events>} - Object containing event emitter methods and hook`