@fast-china/utils 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,380 @@
+import * as vue from 'vue';
+import { Plugin, Directive, PropType, ComputedRef, SlotsType, VNode } from 'vue';
+
+declare const base64Util: {
+    bota(string: string): string;
+    atob(string: string): string;
+    /**
+     * 字符串ToBase64
+     */
+    toBase64(str: string, prefixStrLength?: number): string;
+    /**
+     * Base64转字符串
+     */
+    base64ToStr(str: string, prefixStrLength?: number): string;
+};
+
+declare const clickUtil: {
+    /**
+     * 防抖
+     * @param fn - 执行函数
+     * @param delay - 延时毫秒
+     * @returns 返回一个新的防抖函数
+     */
+    debounce(fn: () => void, delay?: number): void;
+    /**
+     * 异步防抖
+     * @param fn - 执行函数
+     * @param delay - 延时毫秒
+     * @returns 返回一个新的防抖函数
+     */
+    debounceAsync(fn: () => Promise<void>, delay?: number): Promise<void>;
+    /**
+     * 节流
+     * @param fn - 执行函数
+     * @param delay - 延时毫秒
+     * @returns 返回一个新的节流函数
+     */
+    throttle(fn: () => void, delay?: number): void;
+    /**
+     * 异步节流
+     * @param fn - 执行函数
+     * @param delay - 延时毫秒
+     * @returns 返回一个新的节流函数
+     */
+    throttleAsync(fn: () => Promise<void>, delay?: number): Promise<void>;
+};
+
+declare const colorUtil: {
+    /**
+     * hex颜色转rgb颜色
+     * @param str 颜色值字符串
+     * @returns 返回处理后的颜色值
+     */
+    hexToRgb(str: any): any;
+    /**
+     * rgb颜色转Hex颜色
+     * @param r 代表红色
+     * @param g 代表绿色
+     * @param b 代表蓝色
+     * @returns 返回处理后的颜色值
+     */
+    rgbToHex(r: any, g: any, b: any): string;
+    /**
+     * 加深颜色值
+     * @param color 颜色值字符串
+     * @param level 加深的程度，限0-1之间
+     * @returns 返回处理后的颜色值
+     */
+    getDarkColor(color: string, level: number): string;
+    /**
+     * 变浅颜色值
+     * @param color 颜色值字符串
+     * @param level 加深的程度，限0-1之间
+     * @returns 返回处理后的颜色值
+     */
+    getLightColor(color: string, level: number): string;
+};
+
+/**
+ * 打印 Log 日志
+ * @param name 来源名称
+ */
+declare const consoleLog: (name: string, message?: string | false, error?: any) => void;
+/**
+ * 打印 Warn 日志
+ * @param name 来源名称
+ */
+declare const consoleWarn: (name: string, message?: string | false, error?: any) => void;
+/**
+ * 打印 Debug 日志
+ * @param name 来源名称
+ */
+declare const consoleDebug: (name: string, message?: string | false, error?: any) => void;
+/**
+ * 打印 Error 日志
+ * @param name 来源名称
+ */
+declare const consoleError: (name: string, message?: any) => void;
+/**
+ * 抛出错误
+ * @param name 来源名称
+ */
+declare const throwError: (name: string, message?: any) => never;
+
+/**
+ * 加密解密
+ */
+declare const cryptoUtil: {
+    /**
+     * AES
+     */
+    aes: {
+        /**
+         * AES加密
+         * @param dataStr 要加密的字符串
+         * @param key 用于加密的密钥
+         * @param vector 用于加密的向量（IV）
+         * @param cipherMode 加密模式，默认为CBC模式
+         */
+        encrypt(dataStr: string, key: string, vector: string, cipherMode?: any): string;
+        /**
+         * AES解密
+         * @param dataStr 要解密的Base64编码字符串
+         * @param key 用于解密的密钥
+         * @param vector 用于解密的向量（IV）
+         * @param cipherMode 解密模式，默认为CBC模式
+         */
+        decrypt<T = string>(dataStr: string, key: string, vector: string, cipherMode?: any): T | null;
+    };
+    /**
+     * SHA1
+     */
+    sha1: {
+        /**
+         * SHA1加密
+         * @param dataStr 要加密的字符串
+         */
+        encrypt(dataStr: string): string;
+    };
+    /**
+     * MD5
+     */
+    MD5: {
+        /**
+         * MD5加密
+         * @param dataStr 要加密的字符串
+         */
+        encrypt(dataStr: string): string;
+    };
+};
+
+/**
+ * Date工具类
+ */
+declare const dateUtil: {
+    /**
+     * 根据当前时间生成问候语
+     */
+    getGreet(): string;
+    /**
+     * 时间处理翻译
+     */
+    dateTimeFix(date: string | Date | null | undefined): string;
+    getDefaultTime(): Date[];
+    getSimpleTime(): Date;
+    getSimpleShortcuts(): {
+        text: string;
+        value: () => Date;
+    }[];
+    getShortcuts(): {
+        text: string;
+        value: () => Date[];
+    }[];
+    getDisabledDate(time: Date): boolean;
+};
+
+/**
+ * 添加单位
+ * @param value 字符串或数字类型
+ * @param defaultUnit 单位
+ */
+declare const addUnit: (value?: string | number, defaultUnit?: string) => string;
+
+declare class FastError extends Error {
+    constructor(m: string);
+}
+
+/**
+ * 对象工具类
+ */
+declare const objectUtil: {
+    /**
+     * 对象URL参数化
+     */
+    objectToQueryString(obj: any): string;
+    /**
+     * 是否存在重复值
+     */
+    hasDuplicateProperty<T>(arr: T[], prop: keyof T): boolean;
+    /**
+     * 是否存在非重复值
+     */
+    hasDifferentProperty<T>(arr: T[], prop: keyof T): boolean;
+    /**
+     * 时间处理翻译
+     */
+    dateTimeFix(date: string | Date | null | undefined): string;
+};
+
+/**
+ * 本地缓存前缀 Key
+ */
+declare const CACHE_PREFIX: vue.ComputedRef<string>;
+/**
+ * 本地缓存过期值后缀 Key
+ */
+declare const CACHE_EXPIRE_SUFFIX: vue.ComputedRef<string>;
+declare const useStorage: () => {
+    /**
+     * 设置缓存前缀 Key
+     * @param key
+     */
+    prefix(key: string): void;
+    /**
+     * 缓存过期值后缀 Key
+     * @param key
+     */
+    expireSuffix(key: string): void;
+    /**
+     * 设置缓存是否加密
+     * @param crypto
+     */
+    crypto(crypto: boolean): void;
+};
+/**
+ * window.localStorage
+ * - 如果是 UniApp 环境则使用的是 uni.xxxStorage
+ */
+declare const Local: {
+    /**
+     * 设置
+     * @param key 缓存的Key
+     * @param val 缓存值
+     * @param expire 过期时间，单位分钟
+     * @param encrypt 是否对缓存的数据加密
+     */
+    set(key: string, val: any, expire?: number, encrypt?: boolean): void;
+    /**
+     * 获取
+     * @param key 缓存的Key
+     * @param decrypt 是否对缓存的数据解密
+     * @returns {T} 传入的对象类型，默认为 string
+     */
+    get<T = string>(key: string, decrypt?: boolean): T;
+    /**
+     * 移除
+     * @param key 缓存的Key
+     */
+    remove(key: string): void;
+    /**
+     * 根据前缀移除
+     * @param key 缓存的Key
+     */
+    removeByPrefix(key: string): void;
+    /**
+     * 移除全部
+     */
+    clear(): void;
+};
+/**
+ * window.sessionStorage
+ * - UniApp 环境下不可用
+ */
+declare const Session: {
+    /**
+     * 设置会话缓存
+     * @param key 缓存的Key
+     * @param val 缓存值
+     * @param expire 过期时间，单位分钟
+     * @param encrypt 是否对缓存的数据加密
+     */
+    set(key: string, val: any, expire?: number, encrypt?: boolean): void;
+    /**
+     * 获取会话缓存
+     * @param key 缓存的Key
+     * @param decrypt 是否对缓存的数据解密
+     * @returns {T} 传入的对象类型，默认为 string
+     */
+    get<T = string>(key: string, decrypt?: boolean): T;
+    /**
+     * 移除会话缓存
+     * @param key 缓存的Key
+     */
+    remove(key: string): void;
+    /**
+     * 根据前缀移除会话缓存
+     * @param key 缓存的Key
+     */
+    removeByPrefix(key: string): void;
+    /**
+     * 移除全部会话缓存
+     */
+    clear(): void;
+};
+
+/**
+ * 字符串工具类
+ */
+declare const stringUtil: {
+    /**
+     * 获取Url参数
+     */
+    getUrlParams(url: string): Record<string, any>;
+    /**
+     * 是否为JSON字符串
+     */
+    isJson(value: string): boolean;
+    /**
+     * 生成随机字符串
+     */
+    generateRandomString(length: number): string;
+    /**
+     * @description 生成唯一 uuid
+     */
+    generateUUID(): string;
+    /**
+     * 复制
+     */
+    copy(value: string): Promise<void>;
+};
+
+/**
+ * 构建 expose 和 vue.js devtools 状态查看
+ */
+declare const useExpose: <Exposed extends Record<string, any> = Record<string, any>>(expose: (exposed?: Exposed) => void, exposed?: Exposed) => Exposed;
+
+/**
+ * 执行方法
+ * @param fn 要执行的方法
+ * @param args 参数
+ */
+declare const execFunction: <T = void>(fn: Function, ...args: any[]) => Promise<T>;
+
+type TSXWithInstall<T> = T & Plugin;
+declare const withInstall: <T, E extends Record<string, any>>(main: T, extra?: E) => TSXWithInstall<T> & E;
+declare const withNoopInstall: <T>(component: T) => TSXWithInstall<T>;
+declare const withInstallDirective: <T extends Directive>(directive: T, name: string) => TSXWithInstall<T>;
+
+declare const definePropType: <T>(val: any) => PropType<T>;
+/**
+ * 构建 props
+ * @param props props
+ * @param rawProps 原生 props
+ * @param ignoreRawProps 忽略 原生 props 的 key
+ */
+declare const useProps: <T extends Record<string, unknown>, RT extends Record<string, unknown>>(props: T, rawProps?: RT, ignoreRawProps?: (keyof RT)[]) => ComputedRef<Record<string, unknown>>;
+
+type RawSlots = Record<string, unknown>;
+type VueSlots<T> = [T] extends [never] ? () => VNode[] : (arg: T) => VNode[];
+type MakeSlots<T extends RawSlots> = {
+    [K in keyof T]: VueSlots<T[K]>;
+};
+/**
+ * 构建 slots
+ */
+declare const makeSlots: <Slots extends RawSlots>() => SlotsType<Partial<MakeSlots<Slots>>>;
+
+/**
+ * 使用渲染
+ * @description 为了解决使用 TSX 语法返回渲染函数，状态不会出现在 vue.js devtools 中
+ */
+declare const useRender: (render: () => VNode) => void;
+
+/**
+ * 定义类型数据
+ * @description 传入什么就返回什么，用来定义reactive或其他对象的响应式数据
+ */
+declare const withDefineType: <T>(data?: T) => T;
+
+export { CACHE_EXPIRE_SUFFIX, CACHE_PREFIX, FastError, Local, Session, type TSXWithInstall, addUnit, base64Util, clickUtil, colorUtil, consoleDebug, consoleError, consoleLog, consoleWarn, cryptoUtil, dateUtil, definePropType, execFunction, makeSlots, objectUtil, stringUtil, throwError, useExpose, useProps, useRender, useStorage, withDefineType, withInstall, withInstallDirective, withNoopInstall };