@zcrkey/js-utils 0.0.5 → 0.0.6

package/dist/esm/eventCenter.d.ts

@@ -0,0 +1,59 @@
+export type TSubscribers = {
+    key: string;
+    listeners: Array<(...args: any) => void>;
+};
+export type TSubscription = {
+    key: string;
+    listener: (...args: any) => void;
+    remove: () => void;
+};
+export default class CrEventCenter {
+    /**
+     * 储存订阅者
+     */
+    static subscribers: TSubscribers[];
+    /**
+     * 新增订阅
+     *
+     * @param {*} key 名称
+     * @param {*} listener 执行函数
+     * @returns 订阅信息
+     * @example
+       this.subscription = CrEventCenter.on('名称', (参数) => {});
+     */
+    static on(key: string, listener: (...args: any) => void): TSubscription;
+    /**
+     * 移除订阅
+     *
+     * @param {*} subscription
+     * @param {*} type 'all'
+     * @example
+       CrEventCenter.off(this.subscription);
+     */
+    static off(subscription: TSubscription, type?: 'all'): void;
+    /**
+     * 派发事件
+     *
+     * @param {*} key 名称
+     * @param {*} args 其余参数
+     * @example
+       CrEventCenter.emit('名称', 参数数据);
+     */
+    static emit(key: string, ...args: any): void;
+    /**
+     * 查找事件
+     *
+     * @param {*} key 名称
+     * @example
+      let subscriber = CrEventCenter.find('名称');
+     */
+    static find(key: string): TSubscribers | undefined;
+    /**
+     * 清理所有事件
+     *
+     * @memberof CrEventCenter
+     * @example
+       CrEventCenter.clear();
+     */
+    static clear(): void;
+}

package/{src/index.ts → dist/esm/index.d.ts}

@@ -1,8 +1,8 @@
-export type * from './eventCenter';
-export { default as CrEventCenter } from './eventCenter';
-export type * from './objUtil';
-export { default as CrObjUtil } from './objUtil';
-export { default as CrStorage } from './storage';
-export type * from './treeUtil';
-export { default as CrTreeUtil } from './treeUtil';
-export { default as CrUtil } from './util';
+export type * from './eventCenter';
+export { default as CrEventCenter } from './eventCenter';
+export type * from './objUtil';
+export { default as CrObjUtil } from './objUtil';
+export { default as CrStorage } from './storage';
+export type * from './treeUtil';
+export { default as CrTreeUtil } from './treeUtil';
+export { default as CrUtil } from './util';

package/dist/esm/objUtil.d.ts

@@ -0,0 +1,12 @@
+import { PropertyPath } from 'lodash';
+export type { PropertyPath };
+export default class CrObjUtil {
+    /**
+     * 根据字段路径获取对象值
+     * @param obj { 'a': [{ 'b': { 'c': 3 } }] }
+     * @param path 'a[0].b.c' | ['a', '0', 'b', 'c']
+     * @param defaultValue 找不到时返回的默认值
+     * @returns
+     */
+    static getValueByPath(obj: Record<string | number | symbol, any>, propertyPath: PropertyPath, defaultValue?: any): any;
+}

package/dist/esm/storage.d.ts

@@ -0,0 +1,44 @@
+export default class CrStorage {
+    /**
+     * 设置本地存储
+     * @param key
+     * @param data
+     */
+    static setLocalItem(key: string, data: any): void;
+    /**
+     * 获取本地存储
+     * @param key
+     * @returns
+     */
+    static getLocalItem<T = any>(key: string): T | null;
+    /**
+     * 清除某个本地存储
+     * @param key
+     */
+    static removeLocalItem(key: string): void;
+    /**
+     * 清除所有本地存储
+     */
+    static clearLocal(): void;
+    /**
+     * 设置会话存储
+     * @param key
+     * @param data
+     */
+    static setSessionItem(key: string, data: any): void;
+    /**
+     * 获取会话存储
+     * @param key
+     * @returns
+     */
+    static getSessionItem<T = any>(key: string): T | null;
+    /**
+     * 清除某个会话存储
+     * @param key
+     */
+    static removeSessionItem(key: string): void;
+    /**
+     * 清除所有会话存储
+     */
+    static clearSession(): void;
+}

package/dist/esm/treeUtil.d.ts

@@ -0,0 +1,48 @@
+export default class CrTreeUtil {
+    /**
+     * 列表数据转树形数据
+     * @param list
+     * @param options
+     * @param options.idField 默认值 id
+     * @param options.parentIdField 默认值 parentId
+     * @param options.childrenField 默认值 children
+     * @param options.isCloneDeep 是否需要深拷贝, 默认值为 true
+     * @param options.getData 处理数据
+     * @returns
+     */
+    static listToTree<T extends Record<string, any>>(list: T[], options?: {
+        idField?: string;
+        parentIdField?: string;
+        childrenField?: string;
+        isCloneDeep?: boolean;
+        getData?: (item: T) => any;
+    }): any[];
+    /**
+     * 树形数据转列表数据
+     * @param tree
+     * @param options
+     * @param options.childrenField 默认值 children
+     * @param options.isCloneDeep 是否需要深拷贝, 默认值为 true
+     * @returns
+     */
+    static treeToList<T extends Record<string, any>>(tree: T[], options?: {
+        childrenField?: string;
+        isCloneDeep?: boolean;
+    }): T[];
+    /**
+     * 获取扁平化父数据(包含自身)
+     * @param listData
+     * @param value
+     * @param settings
+     * @param settings.valueField 默认值 value
+     * @param settings.idField 默认值 id
+     * @param settings.parentIdField 默认值 parentId
+     * @param settings.getData 过滤数据
+     */
+    static getFlatParentDatas<T = any, R extends Record<string, any> = any>(listData: R[], value: number | string, settings?: {
+        valueField?: string;
+        idField?: string;
+        parentIdField?: string;
+        getData?: (item: R) => T;
+    }): T[];
+}

package/dist/esm/util.d.ts

@@ -0,0 +1,209 @@
+export default class CrUtil {
+    /**
+     * 判断是否为数组
+     * @param value
+     * @returns boolean
+     */
+    static isArray<T = any>(value: any): value is T[];
+    /**
+     * 判断是否为对象
+     * @param value
+     * @returns boolean
+     */
+    static isObject<T = any>(value: T): value is T extends object ? (T extends any[] ? never : T) : never;
+    /**
+     * 判断是否为空对象
+     * @param value
+     * @returns boolean
+     */
+    static isEmptyObject(value: object): value is Record<string | number, never>;
+    /**
+     * 判断是否对象的属性是否全部为空
+     * @param value
+     * @returns boolean
+     */
+    static isObjectPropertiesAllEmpty(value: Record<string | number, any>): boolean;
+    /**
+     * 判断是否为日期
+     * @param value
+     * @returns boolean
+     */
+    static isDate(value: unknown): boolean;
+    /**
+     * 判断是否为字符串
+     * @param value
+     * @returns boolean
+     */
+    static isString(value: unknown): value is string;
+    /**
+     * 判断是否为数字
+     * @param value
+     * @returns boolean
+     */
+    static isNumber(value: unknown): value is number;
+    /**
+     * 判断是否为文件 File
+     * @param value
+     * @returns boolean
+     */
+    static isFile(value: unknown): value is File;
+    /**
+     * 判断是否为 Boolean
+     * @param value
+     * @returns boolean
+     */
+    static isBoolean(value: unknown): value is boolean;
+    /**
+     * 判断是否为 Function
+     * @param value
+     * @returns boolean
+     */
+    static isFunction(value: unknown): value is (...args: any[]) => any;
+    /**
+     * 去掉字符串前后所有空格
+     * @param str
+     * @returns string
+     */
+    static trim(str: string): string;
+    /**
+     * 获取数组为几维数组
+     * @param arr
+     * @returns number
+     */
+    static getArrayDimension(arr: any[]): number;
+    /**
+     * 深拷贝
+     * @param value
+     * @returns
+     */
+    static cloneDeep<T>(value: T): T;
+    /**
+     * 深拷贝
+     * @param target
+     * @deprecated 即将移除，使用 {@link CrUtil.cloneDeep} 替代
+     * @returns
+     */
+    static deepCopy<T = any>(target: T): T;
+    /**
+     * 列表数据转树型数据
+     * @param listData
+     * @param settings
+     * @param settings.idField 默认值 id
+     * @param settings.pidField 默认值 parentId
+     * @param settings.childrenField 默认值 children
+     * @deprecated 即将移除，使用 {@link CrObjUtil.listToTree} 替代
+     * @returns
+     */
+    static listToTreeData(listData: any[], settings?: {
+        idField?: string;
+        pidField?: string;
+        childrenField?: string;
+        isDeepCopy?: boolean;
+        getData?: (item: any) => any;
+    }): any[];
+    /**
+     * 树型数据转列表数据
+     * @param treeData
+     * @param settings
+     * @param settings.idField 默认值 id
+     * @param settings.pidField 默认值 parentId
+     * @param settings.childrenField 默认值 children
+     * @deprecated 即将移除，使用 {@link CrObjUtil.treeToList} 替代
+     * @returns
+     */
+    static treeDataToListData(treeData: any[], pid?: string | number, settings?: {
+        childrenField?: string;
+        idField?: string;
+        pidField?: string;
+        isDeepCopy?: boolean;
+    }): any[];
+    /**
+     * 获取所有父级数据（包含自身）
+     * @param listData
+     * @param value
+     * @param settings
+     * @param settings.valueField 默认值 value
+     * @param settings.idField 默认值 id
+     * @param settings.pidField 默认值 parentId
+     * @deprecated 即将移除，使用 {@link CrObjUtil.getFlatParentDatas} 替代
+     * @returns
+     */
+    static getParentNodes<T, R extends Record<string, any>>(listData: R[], value: number | string, settings?: {
+        valueField?: string;
+        idField?: string;
+        pidField?: string;
+        getData?: (item: R) => T;
+    }): T[];
+    /**
+     * 参数序列化
+     * @param params {a:'1',b:{},c:[]}
+     * @returns
+     */
+    static paramsSerializer(params: Record<string, any>, settings?: {
+        isFilterNonNull: boolean;
+    }): string;
+    /**
+     * 参数解析
+     * @param {*} str
+     * @param {*} settings
+     * @returns
+     */
+    static paramsParse(str: string, settings?: {
+        ignoreQueryPrefix: boolean;
+    }): {};
+    /**
+     * 获取 URL 参数
+     * @param {*} url
+     * @returns
+     * @example
+     * "https://example.com?foo=bar&baz=qux" => {"query":{"foo":"bar","baz":"qux"},"hash":{},"all":{"foo":"bar","baz":"qux"}}
+     * "https://example.com/page?foo=1#/?a=1&b=2" => {"query":{"foo":"1"},"hash":{"/":"","a":"1","b":"2"},"all":{"foo":"1","/":"","a":"1","b":"2"}},
+     */
+    static getQueryParams(url: string): {
+        query: Record<string, any>;
+        hash: Record<string, any>;
+        all: Record<string, any>;
+    };
+    /**
+     * 版本号比较
+     * @param v1
+     * @param v2
+     * @returns number
+     * @description v1大于v2(1)、v1小于v2(-1)、v1等于v2(0)
+     */
+    static compareVersion(v1: string, v2: string): number;
+    /**
+     * 根据 ids 获取相对应的数据名称
+     * @param data
+     * @param ids
+     * @param settings
+     * @returns string
+     */
+    static getDataNameByIds<T extends Record<string, any>>(data: T[], ids: (string | number)[], settings?: {
+        sep?: string;
+        nameField?: string;
+        idField?: string;
+    }): string;
+    /**
+     * 追加html标签属性值
+     * @param htmlStr
+     * @param tagName
+     * @param attrName
+     * @param newAttrValue
+     * @returns string
+     */
+    static appendHtmlTagAttr(htmlStr: string, tagName: string, attrName: string, newAttrValue: string): string;
+    /**
+     * 比较数据差异
+     * @param data1
+     * @param data2
+     * @returns
+     */
+    static compareDataDiff(data1: any, data2: any): Record<string, "added" | "removed" | "modified">;
+    /**
+     * 格式化为千分位
+     * @param value
+     * @returns 12345.6789 => 12,345.6789
+     */
+    static fmtThousands(value: number | string | undefined): string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zcrkey/js-utils",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "一个 javascript 实用函数库",
   "keywords": [
     "js"
@@ -10,9 +10,20 @@
     "url": "https://cnb.cool/cnbkey/zcrkey/js-utils.git"
   },
   "license": "MIT",
-  "main": "dist/index.umd.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js"
+    }
+  },
+  "main": "dist/cjs/index.js",
+  "unpkg": "dist/umd/index.umd.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "files": [
+    "dist",
+    "README.html"
+  ],
   "dependencies": {
     "lodash": "^4.17.21",
     "qs": "^6.11.2"