@jelper/hooks 0.3.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>>) => 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) => 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/es/useIsUnmount.js

@@ -1,11 +0,0 @@
-import { useCallback, useEffect, useRef } from 'react';
-const useIsUnmount = () => {
-    const ref = useRef(true);
-    useEffect(() => {
-        return () => {
-            ref.current = false;
-        };
-    }, []);
-    return useCallback(() => !ref.current, []);
-};
-export default useIsUnmount;

package/es/useListener.js

@@ -1,17 +0,0 @@
-import { useCallback } from 'react';
-import useRtCb from './useRtCb';
-import useRtEffect from './useRtEffect';
-const useListener = (type, listener, options) => {
-    const cb = useRtCb(listener);
-    const remove = useCallback(() => {
-        window.removeEventListener(type, cb);
-    }, []);
-    useRtEffect(() => {
-        window.addEventListener(type, cb, options);
-        return () => {
-            window.removeEventListener(type, cb);
-        };
-    });
-    return remove;
-};
-export default useListener;

package/es/useParamsState.js

@@ -1,9 +0,0 @@
-import { useCallback } from 'react';
-import useSafeState from './useSafeState';
-export default function useParamsState(defData) {
-    const [data, setData] = useSafeState(defData);
-    const update = useCallback((params) => {
-        setData((oldVal) => (Object.assign(Object.assign({}, (oldVal || {})), params)));
-    }, []);
-    return [data, update, setData];
-}

package/es/useRtEffect.js

@@ -1,7 +0,0 @@
-import { useEffect } from 'react';
-import useRtCb from './useRtCb';
-const useRtEffect = (cb, deps) => {
-    const rtCb = useRtCb(cb, deps);
-    useEffect(rtCb, [rtCb]);
-};
-export default useRtEffect;

package/es/useSafeCb.js

@@ -1,11 +0,0 @@
-import { useCallback } from 'react';
-import useIsUnmount from './useIsUnmount';
-const useSafeCb = (cb, deps) => {
-    const isUnmount = useIsUnmount();
-    return useCallback((...arg) => {
-        if (!isUnmount()) {
-            return cb(...arg);
-        }
-    }, deps || []);
-};
-export default useSafeCb;

package/es/useSafeState.js

@@ -1,8 +0,0 @@
-import { useState } from 'react';
-import useSafeCb from './useSafeCb';
-const useSafeState = (value) => {
-    const [state, setState] = useState(value);
-    const setCb = useSafeCb(setState);
-    return [state, setCb];
-};
-export default useSafeState;

package/es/useUpdateEffect.js

@@ -1,12 +0,0 @@
-import { useRef, useEffect } from 'react';
-export default function useUpdateEffect(cb, deps) {
-    const ref = useRef(true);
-    useEffect(() => {
-        if (ref.current) {
-            ref.current = false;
-            return;
-        }
-        return cb();
-    }, deps);
-}
-;

package/lib/useIsUnmount.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = require("react");
-var useIsUnmount = function () {
-    var ref = (0, react_1.useRef)(true);
-    (0, react_1.useEffect)(function () {
-        return function () {
-            ref.current = false;
-        };
-    }, []);
-    return (0, react_1.useCallback)(function () { return !ref.current; }, []);
-};
-exports.default = useIsUnmount;

package/lib/useListener.js

@@ -1,22 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = require("react");
-var useRtCb_1 = __importDefault(require("./useRtCb"));
-var useRtEffect_1 = __importDefault(require("./useRtEffect"));
-var useListener = function (type, listener, options) {
-    var cb = (0, useRtCb_1.default)(listener);
-    var remove = (0, react_1.useCallback)(function () {
-        window.removeEventListener(type, cb);
-    }, []);
-    (0, useRtEffect_1.default)(function () {
-        window.addEventListener(type, cb, options);
-        return function () {
-            window.removeEventListener(type, cb);
-        };
-    });
-    return remove;
-};
-exports.default = useListener;

package/lib/useParamsState.js

@@ -1,26 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = require("react");
-var useSafeState_1 = __importDefault(require("./useSafeState"));
-function useParamsState(defData) {
-    var _a = (0, useSafeState_1.default)(defData), data = _a[0], setData = _a[1];
-    var update = (0, react_1.useCallback)(function (params) {
-        setData(function (oldVal) { return (__assign(__assign({}, (oldVal || {})), params)); });
-    }, []);
-    return [data, update, setData];
-}
-exports.default = useParamsState;

package/lib/useRtEffect.js

@@ -1,12 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = require("react");
-var useRtCb_1 = __importDefault(require("./useRtCb"));
-var useRtEffect = function (cb, deps) {
-    var rtCb = (0, useRtCb_1.default)(cb, deps);
-    (0, react_1.useEffect)(rtCb, [rtCb]);
-};
-exports.default = useRtEffect;

package/lib/useSafeCb.js

@@ -1,20 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = require("react");
-var useIsUnmount_1 = __importDefault(require("./useIsUnmount"));
-var useSafeCb = function (cb, deps) {
-    var isUnmount = (0, useIsUnmount_1.default)();
-    return (0, react_1.useCallback)(function () {
-        var arg = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            arg[_i] = arguments[_i];
-        }
-        if (!isUnmount()) {
-            return cb.apply(void 0, arg);
-        }
-    }, deps || []);
-};
-exports.default = useSafeCb;

package/lib/useSafeState.js

@@ -1,13 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = require("react");
-var useSafeCb_1 = __importDefault(require("./useSafeCb"));
-var useSafeState = function (value) {
-    var _a = (0, react_1.useState)(value), state = _a[0], setState = _a[1];
-    var setCb = (0, useSafeCb_1.default)(setState);
-    return [state, setCb];
-};
-exports.default = useSafeState;

package/lib/useUpdateEffect.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = require("react");
-function useUpdateEffect(cb, deps) {
-    var ref = (0, react_1.useRef)(true);
-    (0, react_1.useEffect)(function () {
-        if (ref.current) {
-            ref.current = false;
-            return;
-        }
-        return cb();
-    }, deps);
-}
-exports.default = useUpdateEffect;
-;

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) => T;
-export default useSafeCb;

package/types/useSafeState.d.ts

@@ -1,5 +0,0 @@
-declare const useSafeState: <T>(value?: T) => [
-    s: T | undefined,
-    setFn: React.Dispatch<React.SetStateAction<T | undefined>>
-];
-export default useSafeState;

package/types/useUpdateEffect.d.ts

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