@jelper/hooks 0.2.0 → 1.0.0

package/types/useAsync.d.ts

@@ -1,13 +1,27 @@
-interface Opt<T extends (...arg: any) => any, R> {
-    defParam?: Parameters<T>;
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-18 23:44:38
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-19 22:53:22
+ */
+type Parameter<T extends (p: any) => any> = Parameters<T>[0];
+interface Opt<T extends (p: any) => any, R> {
+    defParam?: Parameter<T>;
     immediate?: boolean;
     format?: (p: ReturnType<T>) => R;
     catchParam?: boolean;
+    onAbort?: (this: AbortSignal, ev: Event) => any;
 }
-declare const useAsync: <T extends (...arg: any) => Promise<any>, R extends Object>(asyncFn: T, opt?: Opt<T, R>) => {
-    data: R | null | undefined;
-    run: ReturnFn<(runParam?: Partial<Parameters<T>> | undefined) => Promise<void>>;
-    loading: boolean | undefined;
-    error: null | undefined;
-};
+declare const useAsync: <T extends (p: any, opt?: {
+    signal: AbortController['signal'];
+}) => Promise<any>, R = any>(asyncFn: T, opt?: Opt<T, R>) => [
+    R | undefined,
+    {
+        run: (runParam?: Partial<Parameter<T>>) => Promise<void>;
+        refresh: () => Promise<void>;
+        loading: boolean;
+        error?: Error;
+        param: Partial<Parameter<T>>;
+    }
+];
 export default useAsync;

package/types/useBoolState.d.ts

@@ -1,2 +1,8 @@
-declare const useBoolState: (value: boolean) => (boolean | ((switchValue?: React.SetStateAction<boolean>) => void) | undefined)[];
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-16 11:16:34
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-16 11:21:54
+ */
+declare const useBoolState: (value: boolean) => (boolean | ((switchValue?: React.SetStateAction<boolean>) => void))[];
 export default useBoolState;

package/types/useCreate.d.ts

@@ -1,2 +1,8 @@
-declare const useCreate: (cb: Function) => void;
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-16 11:34:59
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-19 22:53:33
+ */
+declare const useCreate: (cb: () => void) => void;
 export default useCreate;

package/types/useDebounce.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-19 22:55:14
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-19 22:55:14
+ */
 import { DebounceSettings, DebouncedFunc } from 'lodash-es';
 declare const useDebounce: <T extends (...args: any) => any>(cb: T, wait?: number, opts?: DebounceSettings) => DebouncedFunc<T>;
 export default useDebounce;

package/types/useIgnoreAbortErrCb.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-19 22:28:14
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-19 22:57:23
+ */
+/// <reference types="react" />
+interface Opts<T> {
+    onAbort: (err: Error) => T;
+}
+declare const useIgnoreAbortErrCb: <T = any>(cb: (err: Error) => T, deps?: import("react").DependencyList, opts?: Opts<T>) => (err: Error) => T | undefined;
+export default useIgnoreAbortErrCb;

package/types/useInterval.d.ts

@@ -1,2 +1,5 @@
-declare const useInterval: (callback: DefFn, delay: number) => () => void;
+declare const useInterval: () => [
+    (callback: Function, timeout?: number, ...arg: any[]) => void,
+    () => void
+];
 export default useInterval;

package/types/useIsMounted.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-16 21:34:27
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-16 21:37:21
+ */
+declare const useIsMounted: () => (() => boolean);
+export default useIsMounted;

package/types/useIsUnmounted.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-16 21:33:24
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-16 21:35:46
+ */
+declare const useIsUnmounted: () => (() => boolean);
+export default useIsUnmounted;

package/types/useMount.d.ts

@@ -1,2 +1,8 @@
-declare const useMount: (cb: Function) => void;
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-18 00:21:16
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-18 00:21:16
+ */
+declare const useMount: (cb: () => void) => void;
 export default useMount;

package/types/useOption.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-16 11:35:37
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-16 21:31:54
+ */
+declare const useOption: <T extends {}>(defOpt?: Partial<T>) => [
+    Partial<T>,
+    {
+        reset: () => void;
+        setOption: React.Dispatch<React.SetStateAction<Partial<T>>>;
+        update: React.Dispatch<React.SetStateAction<Partial<T>>>;
+    }
+];
+export default useOption;

package/types/useRtCb.d.ts

@@ -1,2 +1,9 @@
-declare const useRtCb: <T extends DefFn, D extends any[]>(cb: T, deps?: D | undefined) => ReturnFn<T>;
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-17 00:22:11
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-17 00:22:56
+ */
+import { DependencyList } from 'react';
+declare const useRtCb: <T extends Function>(cb: T, deps?: DependencyList) => T;
 export default useRtCb;

package/types/useRtRef.d.ts

@@ -1,2 +1,9 @@
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-16 22:19:57
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-17 00:10:45
+ */
 /// <reference types="react" />
-export default function useRtRef<T>(val: T): import("react").MutableRefObject<T | undefined>;
+declare const useRtRef: <T>(val: T) => import("react").MutableRefObject<T>;
+export default useRtRef;

package/types/useSafeRunner.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-16 11:36:09
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-19 22:41:39
+ */
+declare const useSafeRunner: () => (cb: () => void, unmountCb?: () => void) => void;
+export default useSafeRunner;

package/types/useThrottle.d.ts

@@ -1,10 +1,9 @@
-import { ThrottleSettings } from 'lodash-es';
 /**
- * 用于节流函数的钩子函数
- * @param cb - 要节流的函数
- * @param wait - 节流延迟时间，默认为0
- * @param opts - 节流选项对象，默认为{}
- * @returns 节流函数
+ * @Author: apathyjade
+ * @Date: 2025-03-19 22:55:28
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-19 22:55:48
  */
+import { ThrottleSettings } from 'lodash-es';
 declare const useThrottle: <T extends (...args: any) => any>(cb: T, wait?: number, opts?: ThrottleSettings) => import("lodash-es").DebouncedFunc<(...arg: Parameters<T>) => void>;
 export default useThrottle;

package/types/useTimeout.d.ts

@@ -1,8 +1,11 @@
 /**
- * 使用定时器在指定延迟后执行回调函数
- * @param callback - 回调函数
- * @param delay - 延迟时间（毫秒）
- * @returns clearTimer - 清除定时器的函数
+ * @Author: apathyjade
+ * @Date: 2025-03-19 23:10:13
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-19 23:10:13
  */
-declare const useTimeout: (callback: DefFn, delay: number) => () => void;
+declare const useTimeout: () => [
+    (callback: Function, timeout?: number, ...arg: any[]) => void,
+    () => void
+];
 export default useTimeout;

package/types/useUnmount.d.ts

@@ -1,2 +1,8 @@
-declare const useUnmount: (cb: Function) => void;
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-16 11:35:20
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-18 00:17:09
+ */
+declare const useUnmount: (cb: () => void) => void;
 export default useUnmount;

package/types/useUpdateEff.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @Author: apathyjade
+ * @Date: 2025-03-16 11:35:13
+ * @Last Modified by: apathyjade
+ * @Last Modified time: 2025-03-16 11:35:13
+ */
+declare const useUpdateEffect: (cb: React.EffectCallback, deps?: React.DependencyList) => void;
+export default useUpdateEffect;

package/types/useValue.d.ts

@@ -0,0 +1,8 @@
+interface Options<T> {
+    isEqual?: (a: T, b: T) => boolean;
+}
+declare const useValue: <T = any>(value: T, onChange?: (value: T) => void, opts?: Options<T>) => [
+    T,
+    React.Dispatch<React.SetStateAction<T>>
+];
+export default useValue;

package/types/useIsUnmount.d.ts

@@ -1,2 +0,0 @@
-declare const useIsUnmount: () => (() => boolean);
-export default useIsUnmount;

package/types/useListener.d.ts

@@ -1,2 +0,0 @@
-declare const useListener: (type: keyof WindowEventMap, listener: () => any, options?: boolean | AddEventListenerOptions) => () => void;
-export default useListener;

package/types/useParamsState.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="react" />
-export default function useParamsState<T extends object>(defData: T): [
-    d: T | undefined,
-    u: React.Dispatch<React.SetStateAction<Partial<T | undefined>>>,
-    s: React.Dispatch<React.SetStateAction<T | undefined>>
-];

package/types/useRtEffect.d.ts

@@ -1,2 +0,0 @@
-declare const useRtEffect: (cb: any, deps?: any[]) => void;
-export default useRtEffect;

package/types/useRtState.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="react" />
-interface Options<T> {
-    isEqual?: (a: T, b: T) => boolean;
-}
-export default function useRtState<T = any>(value: T, onChange?: (value: T) => void, opts?: Options<T>): (T | import("react").Dispatch<import("react").SetStateAction<T>>)[];
-export {};

package/types/useSafeCb.d.ts

@@ -1,2 +0,0 @@
-declare const useSafeCb: <T extends DefFn, D extends any[]>(cb: T, deps?: D | undefined) => T;
-export default useSafeCb;

package/types/useSafeState.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="react" />
-declare const useSafeState: <T>(value?: T | undefined) => [s: T | undefined, setFn: import("react").Dispatch<import("react").SetStateAction<T | undefined>>];
-export default useSafeState;

package/types/useUpdateEffect.d.ts

@@ -1 +0,0 @@
-export default function useUpdateEffect(cb: () => void, deps: any[]): void;