@siberiacancode/reactuse 0.0.9 → 0.0.11

package/dist/index.d.ts

@@ -46,10 +46,10 @@ type UseBooleanReturn = [
 declare const useBoolean: (initialValue?: boolean) => UseBooleanReturn;
 
 type UseClickOutsideTarget = React.RefObject<Element | null> | (() => Element) | Element;
-type UseClickOutsideReturn<Target extends UseClickOutsideTarget | Array<UseClickOutsideTarget> = any> = React.RefObject<Target>;
+type UseClickOutsideReturn<Target extends UseClickOutsideTarget | UseClickOutsideTarget[]> = React.RefObject<Target>;
 type UseClickOutside = {
-    <Target extends UseClickOutsideTarget | Array<UseClickOutsideTarget> = any>(target: Target, callback: (event: Event) => void): void;
-    <Target extends UseClickOutsideTarget | Array<UseClickOutsideTarget> = any>(callback: (event: Event) => void, target?: never): UseClickOutsideReturn<Target>;
+    <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(target: Target, callback: (event: Event) => void): void;
+    <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(callback: (event: Event) => void, target?: never): UseClickOutsideReturn<Target>;
 };
 declare const useClickOutside: UseClickOutside;
 
@@ -161,7 +161,7 @@ declare const useDefault: <Value>(initialValue: Value | (() => Value), defaultVa
  */
 declare const useDidUpdate: (effect: React.EffectCallback, deps?: React.DependencyList) => void;
 
-/** The use document title options type */
+/** The use document title options */
 interface UseDocumentTitleOptions {
     /** Restore the previous title on unmount */
     restoreOnUnmount?: boolean;
@@ -197,6 +197,8 @@ declare function useDocumentTitle(value?: string, options?: UseDocumentTitleOpti
  */
 declare const useDocumentVisibility: () => DocumentVisibilityState;
 
+declare const useEvent: <Params extends unknown[], Return>(callback: (...args: Params) => Return) => ((...args: Params) => Return);
+
 type UseEventListenerTarget = React.RefObject<Element | null> | (() => Element) | Element | Window | Document;
 type UseEventListenerOptions = boolean | AddEventListenerOptions;
 type UseEventListenerReturn<Target extends UseEventListenerTarget = any> = React.RefObject<Target>;
@@ -245,6 +247,44 @@ type UseHashReturn = [string, (value: string) => void];
  */
 declare const useHash: () => UseHashReturn;
 
+/** The use keys pressed params */
+interface UseHotkeysOptions {
+    /** The target to attach the event listeners to */
+    target?: UseEventListenerTarget;
+    /** Enable or disable the event listeners */
+    enabled?: boolean;
+    /** Whether to prevent the default behavior of the event */
+    preventDefault?: boolean;
+    /** Alias map for hotkeys */
+    aliasMap?: Record<string, string>;
+}
+declare const isHotkeyMatch: (hotkey: string, keys: UseHotkeysKey[]) => boolean;
+type UseHotkeysHotkeys = string[] | string;
+type UseHotkeysKey = {
+    key: string;
+    code: string;
+    alias: string;
+};
+/**
+ * @name useHotkeys
+ * @description - Hook that listens for key press events
+ *
+ * @param {UseHotkeysHotkeys} hotkeys The key or keys to listen for
+ * @param {(event: KeyboardEvent) => void} callback The callback function to be called when the hotkey is pressed
+ * @param {UseEventListenerTarget} [options.target=window] The target to attach the event listeners to
+ * @param {boolean} [options.enabled=true] Enable or disable the event listeners
+ * @param {boolean} [options.preventDefault=true] Whether to prevent the default behavior of the event
+ * @param {Record<string, string>} [options.aliasMap] Alias map for hotkeys
+ * @returns {useKeysPressedReturns} Array of strings with keys that were press
+ *
+ * @example
+ * useHotkeys('control+a', () => console.log('hotkey pressed'));
+ *
+ * @example
+ * useHotkeys('ControlLeft+KeyA', () => console.log('hotkey pressed'));
+ */
+declare const useHotkeys: (hotkeys: UseHotkeysHotkeys, callback: (event: KeyboardEvent) => void, options?: UseHotkeysOptions) => void;
+
 interface UseHoverOptions {
     onEntry?: () => void;
     onLeave?: () => void;
@@ -306,6 +346,24 @@ interface UseIdleReturn {
  */
 declare const useIdle: (milliseconds?: number, { initialState, events }?: UseIdleOptions) => UseIdleReturn;
 
+type UseIntersectionObserverTarget = React.RefObject<Element | null> | (() => Element) | Element;
+interface UseIntersectionObserverOptions extends Omit<IntersectionObserverInit, 'root'> {
+    immediate?: boolean;
+    onChange?: (entry: IntersectionObserverEntry) => void;
+    root?: IntersectionObserverInit['root'] | React.RefObject<Element | null>;
+}
+interface UseIntersectionObserverReturn {
+    inView: boolean;
+    entry?: IntersectionObserverEntry;
+}
+type UseIntersectionObserver = {
+    <Target extends UseIntersectionObserverTarget>(target: Target, options?: UseIntersectionObserverOptions): UseIntersectionObserverReturn;
+    <Target extends UseIntersectionObserverTarget>(options?: UseIntersectionObserverOptions, target?: never): UseIntersectionObserverReturn & {
+        ref: React.RefObject<Target>;
+    };
+};
+declare const useIntersectionObserver: UseIntersectionObserver;
+
 /**
  * @name useIsomorphicLayoutEffect
  * @description - Hook conditionally selects either `useLayoutEffect` or `useEffect` based on the environment
@@ -380,7 +438,7 @@ type UseStorageReturn<Value> = [
     remove: () => void
 ];
 declare const dispatchStorageEvent: (params: Partial<StorageEvent>) => boolean;
-declare const useStorage: <Value>(key: string, params?: UseStorageInitialValue<Value> | UseStorageOptions<Value>) => readonly [Value, (value: Value) => void, () => void];
+declare const useStorage: <Value>(key: string, params?: UseStorageInitialValue<Value> | UseStorageOptions<Value>) => readonly [Value | undefined, (value: Value) => void, () => void];
 
 /**
  * @name useLocalStorage
@@ -394,7 +452,7 @@ declare const useStorage: <Value>(key: string, params?: UseStorageInitialValue<V
  * @example
  * const [value, setValue, removeValue] = useLocalStorage('key', 'value');
  */
-declare const useLocalStorage: <Value>(key: string, initialValue?: UseStorageInitialValue<Value>, options?: UseStorageOptions<Value>) => readonly [Value, (value: Value) => void, () => void];
+declare const useLocalStorage: <Value>(key: string, initialValue?: UseStorageInitialValue<Value>, options?: UseStorageOptions<Value>) => readonly [Value | undefined, (value: Value) => void, () => void];
 
 /**
  * @name useLogger
@@ -517,6 +575,36 @@ declare const useOrientation: () => UseOrientationReturn;
  */
 declare const usePrevious: <Value>(value: Value) => Value | undefined;
 
+/** The use queue return type */
+interface UseQueueReturn<Value> {
+    /** The current queue */
+    queue: Value[];
+    /** Add an element to the queue */
+    add: (element: Value) => void;
+    /** Remove an element from the queue */
+    remove: () => Value;
+    /** Clear the queue */
+    clear: () => void;
+    /** Get the first element of the queue */
+    first: Value;
+    /** Get the last element of the queue */
+    last: Value;
+    /** Get the size of the queue */
+    size: number;
+}
+/**
+ * @name useQueue
+ * @description - Hook that manages a queue
+ *
+ * @template Value The type of the value
+ * @param {Value[]} [initialValue=[]] The initial value of the queue
+ * @returns {UseQueueReturn} An object containing the current queue and functions to interact with the queue
+ *
+ * @example
+ * const { queue, add, remove, clear, first, last, size } = useQueue([1, 2, 3]);
+ */
+declare const useQueue: <Value>(initialValue?: Value[]) => UseQueueReturn<Value>;
+
 /**
  * @name useRenderCount
  * @description - Hook returns count component render times
@@ -546,9 +634,12 @@ interface UseRerenderReturns {
  */
 declare const useRerender: () => UseRerenderReturns;
 
+/** The use script status */
 type UseScriptStatus = 'loading' | 'ready' | 'error' | 'unknown';
 declare const SCRIPT_STATUS_ATTRIBUTE_NAME = "script-status";
+/** The use script options extends from attributes script tag */
 interface UseScriptOptions extends React.ComponentProps<'script'> {
+    /** Whether to remove the script on unmount */
     removeOnUnmount?: boolean;
 }
 /**
@@ -578,7 +669,7 @@ declare const useScript: (src: string, options?: UseScriptOptions) => UseScriptS
  * @example
  * const [value, setValue, removeValue] = useSessionStorage('key', 'value');
  */
-declare const useSessionStorage: <Value>(key: string, initialValue?: UseStorageInitialValue<Value>, options?: UseStorageOptions<Value>) => readonly [Value, (value: Value) => void, () => void];
+declare const useSessionStorage: <Value>(key: string, initialValue?: UseStorageInitialValue<Value>, options?: UseStorageOptions<Value>) => readonly [Value | undefined, (value: Value) => void, () => void];
 
 /**
  * @name useSet
@@ -734,4 +825,4 @@ declare const useWindowSize: (params?: UseWindowSizeParams) => {
     height: number;
 };
 
-export { type ConnectionEffectiveType, type ConnectionType, type OperatingSystem, SCRIPT_STATUS_ATTRIBUTE_NAME, type UseClickOutside, type UseClickOutsideReturn, type UseCounter, type UseCounterOptions, type UseCounterParams, type UseCounterReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseFaviconOptions, type UseFaviconReturn, type UseHover, type UseHoverOptions, type UseHoverReturn, type UseHoverTarget, type UseIdleReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseNetworkReturn, type UseOrientationReturn, type UseScriptOptions, type UseScriptStatus, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseToggleReturn, type UseWindowSizeReturn, dispatchStorageEvent, getConnection, getOperatingSystem, legacyCopyToClipboard, useBattery, useBoolean, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDefault, useDidUpdate, useDocumentTitle, useDocumentVisibility, useEventListener, useFavicon, useHash, useHover, useIdle, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeysPressed, useLocalStorage, useLogger, useMediaQuery, useMount, useNetwork, useOnline, useOperatingSystem, useOrientation, usePrevious, useRenderCount, useRerender, useScript, useSessionStorage, useSet, useStep, useStorage, useTimeout, useToggle, useUnmount, useWindowEvent, useWindowSize };
+export { type ConnectionEffectiveType, type ConnectionType, type OperatingSystem, SCRIPT_STATUS_ATTRIBUTE_NAME, type UseClickOutside, type UseClickOutsideReturn, type UseCounter, type UseCounterOptions, type UseCounterParams, type UseCounterReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseFaviconOptions, type UseFaviconReturn, type UseHover, type UseHoverOptions, type UseHoverReturn, type UseHoverTarget, type UseIdleReturn, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseNetworkReturn, type UseOrientationReturn, type UseQueueReturn, type UseScriptOptions, type UseScriptStatus, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseToggleReturn, type UseWindowSizeReturn, dispatchStorageEvent, getConnection, getOperatingSystem, isHotkeyMatch, legacyCopyToClipboard, useBattery, useBoolean, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDefault, useDidUpdate, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useFavicon, useHash, useHotkeys, useHover, useIdle, useIntersectionObserver, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeysPressed, useLocalStorage, useLogger, useMediaQuery, useMount, useNetwork, useOnline, useOperatingSystem, useOrientation, usePrevious, useQueue, useRenderCount, useRerender, useScript, useSessionStorage, useSet, useStep, useStorage, useTimeout, useToggle, useUnmount, useWindowEvent, useWindowSize };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {
@@ -32,6 +32,7 @@
   "module": "dist/esm/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
+    "prepublishOnly": "yarn type && yarn unit-test run && yarn build",
     "build": "shx rm -rf dist && rollup -c --bundleConfigAsCjs",
     "lint": "eslint . --ext ts --ext tsx --no-error-on-unmatched-pattern --fix",
     "format": "prettier --write **/*.{ts,jsm,md}",

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

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

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

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