@jelper/hooks 0.1.1 → 0.2.0

package/package.json

@@ -1,9 +1,10 @@
 {
 	"name": "@jelper/hooks",
-	"version": "0.1.1",
+	"version": "0.2.0",
 	"description": "react hooks helper",
 	"main": "lib/index.js",
 	"module": "es/index.js",
+	"types": "types/index.d.ts",
 	"keywords": [
 		"store",
 		"helper"
@@ -12,20 +13,21 @@
 		"package.json",
 		"README.md",
 		"es/**",
-		"lib/**"
+		"lib/**",
+		"types/**"
 	],
 	"publishConfig": {
 		"access": "public"
 	},
 	"devDependencies": {
-		"@jelper/builder": "0.1.16",
-		"@types/lodash": "~4.14.182",
+		"@jelper/builder": "0.1.17",
 		"@types/node": "~18.0.0",
-		"@types/react": "~18.2.17"
+		"@types/react": "~18.2.17",
+		"@types/lodash-es": "~4.17.8"
 	},
 	"dependencies": {
-		"lodash": "~4.17.21",
-		"react": "~18.2.0"
+		"react": "~18.2.0",
+		"lodash-es": "~4.17.21"
 	},
 	"author": "apathyjade@outlook.com",
 	"license": "ISC",

package/types/index.d.ts

@@ -0,0 +1,20 @@
+export { default as useSafeState } from './useSafeState';
+export { default as useSafeCb } from './useSafeCb';
+export { default as useRtRef } from './useRtRef';
+export { default as useRtState } from './useRtState';
+export { default as useRtCb } from './useRtCb';
+export { default as useRtEffect } from './useRtEffect';
+export { default as useBoolState } from './useBoolState';
+export { default as useParamsState } from './useParamsState';
+export { default as useUpdateEffect } from './useUpdateEffect';
+export { default as useIsUnmount } from './useIsUnmount';
+export { default as useCreate } from './useCreate';
+export { default as useMount } from './useMount';
+export { default as useUnmount } from './useUnmount';
+export { default as useThrottle } from './useThrottle';
+export { default as useDebounce } from './useDebounce';
+export { default as useAsync } from './useAsync';
+export { default as useTimeout } from './useTimeout';
+export { default as useInterval } from './useInterval';
+export { default as useListener } from './useListener';
+export { default as useResizeObserver } from './useResizeObserver';

package/types/useAsync.d.ts

@@ -0,0 +1,13 @@
+interface Opt<T extends (...arg: any) => any, R> {
+    defParam?: Parameters<T>;
+    immediate?: boolean;
+    format?: (p: ReturnType<T>) => R;
+    catchParam?: boolean;
+}
+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;
+};
+export default useAsync;

package/types/useBoolState.d.ts

@@ -0,0 +1,2 @@
+declare const useBoolState: (value: boolean) => (boolean | ((switchValue?: React.SetStateAction<boolean>) => void) | undefined)[];
+export default useBoolState;

package/types/useCreate.d.ts

@@ -0,0 +1,2 @@
+declare const useCreate: (cb: Function) => void;
+export default useCreate;

package/types/useDebounce.d.ts

@@ -0,0 +1,3 @@
+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/useInterval.d.ts

@@ -0,0 +1,2 @@
+declare const useInterval: (callback: DefFn, delay: number) => () => void;
+export default useInterval;

package/types/useIsUnmount.d.ts

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

package/types/useListener.d.ts

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

package/types/useMount.d.ts

@@ -0,0 +1,2 @@
+declare const useMount: (cb: Function) => void;
+export default useMount;

package/types/useParamsState.d.ts

@@ -0,0 +1,6 @@
+/// <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/useResizeObserver.d.ts

@@ -0,0 +1 @@
+export default function useResizeObserver(dom: HTMLElement, cb: (dom: ResizeObserverEntry) => void): (() => void)[];

package/types/useRtCb.d.ts

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

package/types/useRtEffect.d.ts

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

package/types/useRtRef.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export default function useRtRef<T>(val: T): import("react").MutableRefObject<T | undefined>;

package/types/useRtState.d.ts

@@ -0,0 +1,6 @@
+/// <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

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

package/types/useSafeState.d.ts

@@ -0,0 +1,3 @@
+/// <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/useThrottle.d.ts

@@ -0,0 +1,10 @@
+import { ThrottleSettings } from 'lodash-es';
+/**
+ * 用于节流函数的钩子函数
+ * @param cb - 要节流的函数
+ * @param wait - 节流延迟时间，默认为0
+ * @param opts - 节流选项对象，默认为{}
+ * @returns 节流函数
+ */
+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

@@ -0,0 +1,8 @@
+/**
+ * 使用定时器在指定延迟后执行回调函数
+ * @param callback - 回调函数
+ * @param delay - 延迟时间（毫秒）
+ * @returns clearTimer - 清除定时器的函数
+ */
+declare const useTimeout: (callback: DefFn, delay: number) => () => void;
+export default useTimeout;

package/types/useUnmount.d.ts

@@ -0,0 +1,2 @@
+declare const useUnmount: (cb: Function) => void;
+export default useUnmount;

package/types/useUpdateEffect.d.ts

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