@partex/one-core 2.0.106 → 2.0.108

package/lib/components/common.d.ts

@@ -1,7 +1,7 @@
 import type { ObjectKey, PageModel, PageRecords, Query, Fn } from './interface';
 export declare const getDefaultDate: (year?: number, month?: number, date?: number) => number;
-export declare function fnSetStorage(key: string, value: string | ObjectKey | boolean, expired?: number | string): void;
-export declare function fnGetStorage(key: string, defaultValue: any): any;
+export declare function fnSetStorage<T>(key: string, value: T, expired?: number | string): void;
+export declare function fnGetStorage<T = any>(key: string, defaultValue: any): T;
 export declare const fnDelStorage: (key: string) => void;
 export declare const fnScrollTop: (value?: number) => void;
 export declare const fnDeleteLoad: () => void;

package/lib/components/hooks/index.d.ts

@@ -1,3 +1,4 @@
 export { useDebounceFn } from './useDebounceFn';
 export { useThrottleFn } from './useThrottleFn';
+export { useLocalStorage } from './useLocalStorage';
 export { useQuery } from './useQuery';

package/lib/components/hooks/useDebounceFn.d.ts

@@ -2,7 +2,7 @@ import { DebouncedFunc } from 'lodash';
 /// <reference types="lodash" />
 import type { Fn } from '../interface';
 /**
- * 处理防抖函数
+ * 防抖函数
  * @param fn
  * @param delay
  * @returns

package/lib/components/hooks/useLocalStorage.d.ts

@@ -0,0 +1,29 @@
+import type { Ref, UnwrapRef } from 'vue';
+interface ILocalStorageOptions<T> {
+    /**
+     * 默认数据
+     */
+    defaultValue?: T;
+    /**
+     * 过期时间
+     */
+    expired: number | string;
+}
+type ILocalStorageAction<T> = [
+    /**
+     * 数据
+     */
+    Ref<UnwrapRef<T> | undefined>,
+    /**
+     * 设置数据
+     */
+    (value?: T) => void
+];
+/**
+ * 获取LocalStorage数据
+ * @param key 緩存Key {string}
+ * @param options 配置 {ILocalStorageOptions}
+ * @returns ILocalStorageAction {ILocalStorageAction}
+ */
+export declare function useLocalStorage<T>(key: string, options?: ILocalStorageOptions<T>): ILocalStorageAction<T>;
+export {};

package/lib/components/hooks/useQuery.d.ts

@@ -1,25 +1,77 @@
 import type { Fn } from '../interface';
 import type { Ref } from 'vue';
 type Status = 'loading' | 'idle' | 'error' | 'success';
-interface IQueryResult {
+interface IQueryResult<T> {
+    /**
+     * 请求状态
+     */
     status: Ref<Status>;
+    /**
+     * 加载状态
+     */
     loading: Ref<boolean>;
-    error: Ref<any>;
-    data: any;
+    /**
+     * 错误信息
+     */
+    error: Ref<unknown>;
+    /**
+     * 返回值
+     */
+    data: Readonly<Ref<T | undefined>>;
+    /**
+     * 停止轮询
+     */
     stopPollingInterval: () => void;
+    /**
+     * 取消请求
+     */
     cancel: () => void;
+    /**
+     * 重新请求
+     */
     refetch: () => void;
 }
 interface IQueryOptions {
+    /**
+     * 开启缓存
+     */
     cache?: boolean;
+    /**
+     * 手动触发
+     */
     manual?: boolean;
+    /**
+     * 轮询
+     */
     pollingInterval?: number;
+    /**
+     * 错误重试
+     */
     retry?: {
+        /**
+       * 重试次数
+       */
         retryCount?: number;
+        /**
+       * 重试间隔
+       */
         retryInterval?: number;
     };
+    /**
+     * 返回数据格式化
+     */
     formatResult?: Fn;
+    /**
+     * 初始化数据
+     */
     initialData?: Fn;
 }
-export declare function useQuery(queryKey: string, fetch: Promise<any> | Promise<any>[], options?: IQueryOptions): IQueryResult;
+/**
+ * 获取查询数据
+ * @param queryKey 緩存Key {string}
+ * @param fetch 請求Promise {Fn<any, Promise<any>> | Fn<any, Promise<any>>[]}
+ * @param options 配置 {IQueryOptions}
+ * @returns IQueryResult {IQueryResult}
+ */
+export declare function useQuery<T>(queryKey: string, fetch: Fn<any, Promise<any>> | Fn<any, Promise<any>>[], options?: IQueryOptions): IQueryResult<T>;
 export {};

package/lib/components/hooks/useThrottleFn.d.ts

@@ -1,15 +1,14 @@
 import { DebouncedFunc } from 'lodash';
-import { ComputedRef } from 'vue';
 /// <reference types="lodash" />
 import type { Fn } from '../interface';
 /**
- * 处理节流函数
+ * 节流函数
  * @param fn
  * @param delay
  * @returns
  */
 export declare function useThrottleFn(fn: Fn, wait?: number): {
-    run: ComputedRef<DebouncedFunc<(...args: Parameters<Fn>) => ReturnType<Fn>>>;
+    run: DebouncedFunc<(...args: Parameters<Fn>) => ReturnType<Fn>>;
     cancel: () => void;
     flush: () => any;
 };

package/lib/components/utils/localStorage.d.ts

@@ -1,15 +1,12 @@
-type ObjectKey<T = any> = {
-    [x in string | number]: T;
-};
+import type { ObjectKey } from '../interface';
 export default class LzLocalStorage {
     namespace: string;
     mapKey: string;
     map: ObjectKey;
     constructor(namespace?: string);
-    set(key: string, value: string | ObjectKey | boolean, expires?: number): void;
+    set<T>(key: string, value: T, expires?: number): void;
     getReallyKey(key: string): string;
-    get<T>(key: string, defaultValue: T): T;
+    get<T>(key: string, defaultValue: T): any;
     delete(key: string): void;
     deleteAll(): void;
 }
-export {};