jinbi-utils 1.0.0-beta.1

package/test/number/index.test.ts

@@ -0,0 +1,108 @@
+import { toThousands, convertCurrency, formatFloat, ceil, floor } from '../../src';
+
+describe('toThousands', () => {
+  test(`toThousands('') 返回 '-'`, () => {
+    expect(toThousands('')).toBe('-');
+  })
+
+  test(`toThousands('', '|') 返回 '|'`, () => {
+    expect(toThousands('', '|')).toBe('|');
+  })
+
+  test(`toThousands(123) 返回 '123'`, () => {
+    expect(toThousands(123)).toBe('123');
+  })
+
+  test(`toThousands(12323) 返回 '12,323'`, () => {
+    expect(toThousands(12323)).toBe('12,323');
+  })
+
+  test(`toThousands('12323.12') 返回 '12,323.12'`, () => {
+    expect(toThousands('12323.12')).toBe('12,323.12');
+  })
+});
+
+describe('convertCurrency', () => {
+  test(`convertCurrency() 返回 ''`, () => {
+    expect(convertCurrency()).toBe('');
+  })
+
+  test(`convertCurrency('') 返回 ''`, () => {
+    expect(convertCurrency('-')).toBe('零元整');
+  })
+
+  test(`convertCurrency(1999999999999999) 返回 ''`, () => {
+    const value = '1999999999999999';
+    expect(convertCurrency(value)).toBe(value);
+  })
+
+  test(`convertCurrency(0.012) 返回 '壹分贰毫'`, () => {
+    expect(convertCurrency('0.012')).toBe('壹分贰毫');
+  })
+
+  test(`convertCurrency(0) 返回 '零元整'`, () => {
+    expect(convertCurrency('0')).toBe('零元整');
+  })
+
+  test(`convertCurrency(12.12) 返回 '壹拾贰元壹角贰分'`, () => {
+    expect(convertCurrency('12.12')).toBe('壹拾贰元壹角贰分');
+  })
+
+  test(`convertCurrency(1234567809) 返回 '壹拾贰亿叁仟肆佰伍拾陆万柒仟捌佰零玖元整'`, () => {
+    expect(convertCurrency('1234567809')).toBe('壹拾贰亿叁仟肆佰伍拾陆万柒仟捌佰零玖元整');
+  })
+});
+
+describe('formatFloat', () => {
+  test(`formatFloat('NaN') 返回 ''`, () => {
+    expect(formatFloat('NaN')).toBe('');
+  })
+
+  test(`formatFloat('1.2345') 返回 '1.23'`, () => {
+    expect(formatFloat('1.2345')).toBe('1.23');
+  })
+
+  test(`formatFloat('1.2345') 返回 '1.235'`, () => {
+    expect(formatFloat('1.2345', 3)).toBe('1.235');
+  })
+
+  test(`formatFloat('1', 3) 返回 '1.000'`, () => {
+    expect(formatFloat('1', 3)).toBe('1.000');
+  })
+});
+
+describe('ceil', () => {
+  test(`ceil('') 返回 ''`, () => {
+    expect(ceil('')).toBe('');
+  })
+
+  test(`ceil('1.23') 返回 2`, () => {
+    expect(ceil('1.23')).toBe(2);
+  })
+
+  test(`ceil('1.234', 2) 返回 1.24`, () => {
+    expect(ceil('1.234', 2)).toBe(1.24);
+  })
+
+  test(`ceil('1.230', 2) 返回 1.23`, () => {
+    expect(ceil('1.230', 2)).toBe(1.23);
+  })
+});
+
+describe('floor', () => {
+  test(`floor('') 返回 ''`, () => {
+    expect(floor('')).toBe('');
+  })
+
+  test(`floor('1.23') 返回 1`, () => {
+    expect(floor('1.23')).toBe(1);
+  })
+
+  test(`floor('1.234', 2) 返回 1.23`, () => {
+    expect(floor('1.234', 2)).toBe(1.23);
+  })
+
+  test(`floor('1.230', 2) 返回 1.23`, () => {
+    expect(floor('1.230', 2)).toBe(1.23);
+  })
+});

package/test/object/index.test.ts

@@ -0,0 +1,20 @@
+import { deepEqual } from '../../src';
+
+
+describe('deepEqual', () => {
+  test(`deepEqual(null, null) 返回 true`, () => {
+    expect(deepEqual(null, null)).toBe(true);
+  })
+
+  test(`deepEqual({}, null) 返回 false`, () => {
+    expect(deepEqual({}, null)).toBe(false);
+  })
+
+  test(`deepEqual({a: 10}, {a: 10}) 返回 true`, () => {
+    expect(deepEqual({a: 10}, {a: 10})).toBe(true);
+  })
+
+  test(`deepEqual({a: 10}, {a: 10, b: 20}) 返回 false`, () => {
+    expect(deepEqual({a: 10}, {a: 10, b: 20})).toBe(false);
+  })
+});

package/test/string/index.test.ts

@@ -0,0 +1,82 @@
+import { formatEmptyValue, formatPhone, formatPhoneHide, formatBank, generateEnglishLetters } from '../../src';
+
+describe('formatEmptyValue', () => {
+  test(`formatEmptyValue('') 返回 `, () => {
+    expect(formatEmptyValue('')).toBe('-');
+  })
+
+  test(`formatEmptyValue('123') 返回  123`, () => {
+    expect(formatEmptyValue('123')).toBe('123');
+  })
+
+  test(`formatEmptyValue(null) 返回 '-'`, () => {
+    expect(formatEmptyValue(null)).toBe('-');
+  })
+
+  test(`formatEmptyValue(null, ' ') 返回 ' '`, () => {
+    expect(formatEmptyValue(null, ' ')).toBe(' ');
+  })
+});
+
+describe('formatPhone', () => {
+  test(`formatPhone('') 返回 `, () => {
+    expect(formatPhone('')).toBe('-');
+  })
+
+  test(`formatPhone('', '-', ' ') 返回 ' '`, () => {
+    expect(formatPhone('', '-', ' ')).toBe(' ');
+  })
+
+  test('formatPhone(123) 返回 123', () => {
+    expect(formatPhone('123')).toBe('123');
+  })
+
+  test(`formatPhone(18211572781)  返回 '182 1157 2781'`, () => {
+    expect(formatPhone(18211572781)).toBe('182 1157 2781');
+  })
+
+  test(`formatPhone('18211572781', '-') 放回 '182-1157-2781'`, () => {
+    expect(formatPhone('18211572781', '-')).toBe('182-1157-2781');
+  })
+});
+
+describe('formatPhoneHide', () => {
+  test(`formatPhoneHide('') 返回 ''`, () => {
+    expect(formatPhoneHide('')).toBe('');
+  })
+
+  test('formatPhoneHide(123) 返回 123', () => {
+    expect(formatPhoneHide('123')).toBe('123');
+  })
+
+  test(`formatPhoneHide(18211572781)  返回 '182****2781'`, () => {
+    expect(formatPhoneHide(18211572781)).toBe('182****2781');
+  })
+
+  test(`formatPhoneHide('18211572781', '-') 放回 '182****2781'`, () => {
+    expect(formatPhoneHide('18211572781', '-')).toBe('182****2781');
+  })
+});
+
+describe('formatBank', () => {
+  test(`formatBank('') 返回 ''`, () => {
+    expect(formatBank('')).toBe('');
+  })
+
+  test(`formatBank('', '-') 返回 '-'`, () => {
+    expect(formatBank('', '-')).toBe('-');
+  })
+
+  test(`formatBank(6282356862823568123) 返回 '6282 3568 6282 3568 123'`, () => {
+    expect(formatBank('6282356862823568123')).toBe('6282 3568 6282 3568 123');
+  })
+});
+
+
+describe('generateEnglishLetters', () => {
+  test(`generateEnglishLetters() 返回 ['A', ..., 'Z']`, () => {
+    expect(generateEnglishLetters()).toContain('A');
+    expect(generateEnglishLetters()).toContain('Z');
+    expect(generateEnglishLetters()).toHaveLength(26);
+  })
+});

package/tsconfig.json

@@ -0,0 +1,39 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "es6",
+    "lib": ["es6", "dom", "es2015.collection"],
+    "removeComments": false,
+    "preserveConstEnums": true,
+    "moduleResolution": "node",
+    "experimentalDecorators": true,
+    "noImplicitAny": false,
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "declarationDir": "./types",
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "strictNullChecks": true,
+    "sourceMap": true,
+    "baseUrl": ".",
+    "rootDir": "./src/",
+    "jsx": "preserve",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "typeRoots": [
+      "node_modules/@types",
+      "global.d.ts"
+    ],
+    "paths": {
+      "@/*": ["./src/*"]
+    },
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ],
+  "compileOnSave": true
+}

package/typedoc.json

@@ -0,0 +1,9 @@
+{
+  "excludeNotExported": true,
+  "mode": "modules",
+  "out": "docs",
+  "inputFiles": ["./src"],
+  "exclude": [
+    "src/index.ts"
+  ]
+}

package/types/common/index.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 通用函数
+ * @packageDocumentation
+ * @module Common
+ * @preferred
+ */
+import { IFromType } from "@/constant/common.constant";
+/**
+ * 判断val 是否是空值
+ #### 使用说明
+ ```
+ isEmpty('') 返回 true
+ isEmpty(null) 返回 true
+ isEmpty(undefined) 返回 true
+ isEmpty(12323) 返回 false
+ ```
+ */
+export declare function isEmpty(val: any): boolean;
+export declare const clearLoginData: () => void;
+export declare const getQueryString: (url: string, queryKey: string) => string;
+export declare const getQueryVariable: (variable: any) => string | false;
+export declare const getWecomToken: () => string | null;
+export declare const getDeviceType: () => IFromType;
+export declare const getFromType: (res: IFromType) => string;
+export declare function randomString(e: any): string;
+export declare const getCookie: (cookieName: any) => string;
+export declare const buildUUID: () => string;
+export declare const getTicket: () => string | null;
+export declare const setTicket: (jsapiTicket: any) => void;
+export declare const removeTicket: () => void;
+export declare const formateTimestamp: (timestamp: number | null, type?: string) => string;
+export declare const convertBase64UrlToBlob: (urlData: any) => Blob;
+export declare const getEnvironment: () => "com-wx-mobile" | "com-wx-pc" | "wx-mobile" | "wx-pc" | "other";
+export declare const getIsComWx: () => boolean;
+export declare const getIsDevelopment: () => boolean;
+export declare const filterRepeat: (arr: any[], fieldName: string) => any[];
+export declare const base64ToBlob: (base64: any) => Blob;
+export declare const base64ToFile: (base64: any, fileName: any) => File;
+export declare const isImage: (type: string) => boolean;
+export declare const getFileData: (optionName: string) => {
+    name: string;
+    url: string;
+};
+export declare const validateTwoDecimal: (v: number | string) => boolean;
+export declare const uuid: (len: any, radix: any) => string;
+export declare const getToken: (cacheType: string, key?: string) => string;
+export declare const removeToken: (cacheType: string, key?: string) => void;

package/types/constant/common.constant.d.ts

@@ -0,0 +1,12 @@
+export interface IFromType {
+    isWxWork: boolean;
+    isWeixin: boolean;
+    isMobileScreen: boolean;
+    isMobileAny: boolean;
+}
+export declare const fromTypeMap: {
+    isWxWork: string;
+    isWeixin: string;
+    isMobile: string;
+    isMobileAny: string;
+};

package/types/date/index.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 解决ios不支持 new Date('2020-02-02')问题
+ #### 使用说明
+ ```
+  compatibleDate('2020-03-04') 返回 2020/03/04
+  compatibleDate(Date.now()) 返回 Date.now()
+  compatibleDate(new Date()) 返回 new Date()
+  ```
+ */
+export declare function compatibleDate(date: string | number | Date): string | number | Date;
+/**
+ * 调用原生 new Date 返回 Date实例 解决ios不支持 yyyy-MM-dd HH:mm:ss 格式new Date
+ #### 使用说明
+ ```
+  newDate() 返回 new Date()
+  newDate('2020-03-04') 返回 new Date('2020-03-04')
+  ```
+ */
+export declare function newDate(date?: string | number | Date): Date;
+/**
+ * 格式化时间
+ #### 使用说明
+ ```
+ formatTime() 返回 yyyy-MM-dd HH:mm:ss 格式的当前时间
+ formatTime('2018-02-02 00:00:00') 返回 2018-02-02 00:00:00
+ formatTime('2018-02-02', 'yyyy/MM/dd') 返回 2018/02/02
+ formatTime('2018-02-02 23:50:50', 'yyyy/MM/dd HH:mm:ss') 返回 2018/02/02 23:50:50
+ formatTime('2018-02-02 23:50:50', 'MM/dd HH:mm:ss') 返回 02/02 23:50:50
+ formatTime(new Date('2018-02-02 23:50:50') + 200, 'yyyy/MM/dd HH:mm:ss S') 返回 2018/02/02 23:50:50 200
+ ```
+ */
+export declare function formatTime(date?: string | number | Date, fmt?: string): string;
+/**
+ * 格式化相对时间
+ #### 使用说明
+ ```
+ fromNow('') 返回 -
+ fromNow(Date.now() - 2000) 返回 刚刚
+ fromNow(now - 3420 * 1000) 返回 58分钟前面
+ fromNow(now - 3600 * 1000 * 3) 返回 3小时前
+ fromNow(now - 3600 * 1000 * 24 * 1.5) 返回 1天前
+ fromNow(now - day5) 返回 当前时间的5天前日期 格式 yyyy年MM月dd日 HH时mm分ss秒
+ fromNow(Date.now() + 2000) 返回 Date.now() + 2000
+ fromNow('', '', 'defaultValue') 等于 defaultValue
+ ```
+ */
+export declare function fromNow(time: Date | string | number, fmt?: string, defaultValue?: string): string | number | Date;
+/**
+ * 增加日期天数
+ #### 使用说明
+ ```
+ addDays('') 返回 -
+ addDays('2018-02-02') 返回 2018-02-02
+ addDays('2018-02-02', 2) 返回 2018-02-04
+ addDays('2018-02-02', 2, 'yyyy/MM/dd') 返回 2018/02/04
+ addDays(new Date('2020-03-04'), 2, 'yyyy/MM/dd') 返回 2020/03/06
+ addDays(Date.now(), 2, 'yyyy/MM/dd') 返回 今天 + 2天
+ ```
+ */
+export declare function addDays(date: Date | string | number, days?: string | number, fmt?: string): string;

package/types/file/index.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 文件处理相关
+ * @packageDocumentation
+ * @module File
+ * @preferred
+ */
+export declare type FileSizeUnit = 'B' | 'KB' | 'MB' | 'GB' | 'TB';
+export interface FileSizeObject {
+    size: number;
+    unit: FileSizeUnit;
+}
+/**
+ * 计算文件大小
+ #### 使用说明
+ ```
+ calcFileSize(100) 返回 { size: 100, unit: 'B' }
+ calcFileSize(1024) 返回 { size: 1, unit: 'KB' }
+ calcFileSize(1024, 'KB') 返回 { size: 1, unit: 'MB' }
+ calcFileSize(1126.4, 'mb') 返回 { size: 1.1, unit: 'GB' }
+ calcFileSize(Math.pow(1024, 2), 'kb') 返回 { size: 1, unit: 'GB' }
+ ```
+ * @param size 单位 k
+ * @returns number
+ */
+export declare function calcFileSize(size: number, unit?: FileSizeUnit): FileSizeObject;
+/**
+ * 文件大小转换
+ #### 使用说明
+ ```
+ fileSizeFormat('') 返回 -
+ fileSizeFormat('1024') 返回 1KB
+ fileSizeFormat('1024', 'KB') 返回 1MB
+ fileSizeFormat('2645', 'B') 返回 ceil(2645 / 1024, 2)MB
+ ```
+ * @param {string} str 字符串 单位k
+ */
+export declare function fileSizeFormat(str: string | number, unit?: FileSizeUnit, defaultValue?: string): string;
+/**
+ * base64转换为file
+ * dataurl base64图片
+ * */
+export declare function dataURLtoBlob(dataurl: string): Blob;
+export declare function blobToDataURL(blob: Blob): any;
+export interface CompressImgScaleCallback {
+    (w: number, h: number): number;
+}
+export interface CompressImgQualityCallback {
+    (fileSize: number, scale: number, w: number, h: number): number;
+}
+/**
+ * 压缩图片方法
+ * @param file 图片
+ * @param scaleCallback 宽高 压缩规则
+ * @param qualityCallback 质量 压缩规则
+ */
+export declare function compressImg(file: File, scaleCallback?: CompressImgScaleCallback, qualityCallback?: CompressImgQualityCallback): Promise<Blob>;
+export declare type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
+export interface ExportByBlobParams {
+    /**
+     * 请求方式
+     */
+    method?: Method;
+    /**
+     * 接口地址
+     */
+    url: string;
+    /**
+     * post接口参数
+     */
+    data?: any;
+    /**
+     * get接口参数
+     */
+    params?: any;
+    /**
+    * 导出的文件名称
+    */
+    filename?: string;
+}
+export interface GenExportByBlobParams {
+    /**
+     * axios 请求函数
+     */
+    axiosRequest: any;
+    /**
+     * 不使用 withCredentials 域名
+     */
+    notWithCredentials?: string[];
+}
+/**
+ * 生成导出函数
+ */
+export declare function genExportByBlob({ axiosRequest, notWithCredentials, }: {
+    axiosRequest: any;
+    notWithCredentials?: never[] | undefined;
+}): (config: ExportByBlobParams) => Promise<unknown>;

package/types/http/http.d.ts

@@ -0,0 +1,17 @@
+import { AxiosInstance } from "axios";
+interface IHttp {
+    cacheType: 'localStorage' | 'sessionStorage' | 'both';
+    currentMode: string;
+    errorCb?: (error: any) => void;
+    getTokenCb?: () => void;
+    tokenKey?: 'token';
+}
+/**
+ * @param cacheType localStorage | sessionStorage | both
+ * @param currentMode local | dev | test | prod 等自定义mode
+ * @param errorCb 错误回调
+ * @param getTokenCb 获取token的回调
+ * @param tokenKey
+ * */
+export declare const http: ({ cacheType, currentMode, errorCb, getTokenCb, tokenKey }: IHttp) => AxiosInstance;
+export {};

package/types/http/httpEnums.d.ts

@@ -0,0 +1,53 @@
+export declare const httpEnum: {
+    HTTP_STATUS: {
+        TEMP_RESPOND: {
+            Continue: number;
+            SwitchingProtocal: number;
+        };
+        SUCCESS: {
+            Ok: number;
+            Created: number;
+            Accepted: number;
+            NoAuthoritativeInformation: number;
+            NoContent: number;
+            ResetContent: number;
+            ParticalContent: number;
+        };
+        REDIRECT: {
+            MultipleChoice: number;
+            MovedPermanently: number;
+            Found: number;
+            SeeOther: number;
+            NotModified: number;
+            TemporaryRedirect: number;
+            PermanentRedirect: number;
+        };
+        REQUEST_ERROR: {
+            BadRequest: number;
+            UnAuthorized: number;
+            Forbidden: number;
+            NotFound: number;
+            MethodNotAllowed: number;
+            NotAccepted: number;
+            ProxyAuthorizationRequired: number;
+            RequestTimeout: number;
+            UpgradeRequired: number;
+            TokenUnAuthorized: number;
+        };
+        SERVER_ERROR: {
+            InternalServerError: number;
+            BadGateway: number;
+            ServiceUnavailable: number;
+            GateTimeout: number;
+            HttpVersionNotSupported: number;
+        };
+    };
+    CODES: {
+        Success: string;
+        UnAuthorized: string;
+        UnAuthorizedPhone: string;
+        UnAuthorizedWecom: string;
+        UnAuthorizedHavePhone: string;
+    };
+    ERR_CODE_WHITE_LIST: never[];
+};

package/types/index.d.ts

@@ -0,0 +1,10 @@
+export * from './common';
+export * from './date';
+export * from './file';
+export * from './object';
+export * from './print';
+export * from './validate';
+export * from './number';
+export * from './string';
+export * from './http/httpEnums';
+export * from './http/http';

package/types/number/index.d.ts

@@ -0,0 +1,62 @@
+/**
+ * number处理相关
+ * @packageDocumentation
+ * @module Number
+ * @preferred
+ */
+/**
+ * 千分位格式化
+  #### 使用说明
+  ```
+  toThousands(1) => 1
+  toThousands(12345) => 12,345
+  toThousands('12323.12') 返回 '12,323.12'
+  ```
+ */
+export declare function toThousands(num: number | string, defaultValue?: string): string;
+/**
+ * 阿拉伯数组转中文数字
+ #### 使用说明
+ ```
+ convertCurrency(0) 返回 '壹拾贰元壹角贰分'
+ convertCurrency(1234567809) 返回 '壹拾贰亿叁仟肆佰伍拾陆万柒仟捌佰零玖元整'
+ ```
+ * @param {number} money 金额
+ */
+export declare function convertCurrency(money?: string): string;
+/**
+ * 格式化小数位
+ #### 使用说明
+ ```
+ formatFloat('1.2345') 返回 '1.23'
+ formatFloat('1.2345', 3) 返回 '1.235'
+ formatFloat('1', 3) 返回 '1.000'
+ ```
+ * @param {*} val 小数
+ * @param {number} [pos=2] 保留的小数位
+ */
+export declare function formatFloat(val: string | number, pos?: number): string;
+/**
+ * 向上取整
+ #### 使用说明
+ ```
+ ceil('1.23') 返回 2
+ ceil('1.234', 2) 返回 1.24
+ ceil('1.230', 2) 返回 1.23
+ ```
+ * @param {*} val
+ * @param {number} [pos=2] 保留的小数位
+ */
+export declare function ceil(val: string | number, pos?: number): string | number;
+/**
+ * 向下取整
+ #### 使用说明
+ ```
+ floor('1.23') 返回 1
+ floor('1.234', 2) 返回 1.23
+ floor('1.230', 2) 返回 1.23
+ ```
+ * @param {*} val
+ * @param {number} [pos=2] 保留的小数位
+ */
+export declare function floor(val: string | number, pos?: number): string | number;

package/types/object/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * object处理相关
+ * @packageDocumentation
+ * @module Object
+ * @preferred
+ */
+/**
+ * 比较两者的值是否相等
+ #### 使用说明
+ ```
+ deepEqual({a: 10}, {a: 10}) 返回 true
+ deepEqual({a: 10}, {a: 10, b: 20}) 返回 false
+ ```
+ * @param {*} x 用来比较的值
+ * @param {*} y 另一个用来比较的值
+ */
+export declare function deepEqual(x: any, y: any): any;
+/**
+ * 查找树结构节点路径
+ * @param {*} nodeValue 节点值
+ * @param {string} nodeKey 节点键
+ * @param {Array} treeArray 树数据
+ * @param {string} children 子集键
+ */
+export declare function findNodePath(nodeValue: any, nodeKey: any, treeArray: any, childrenKey: any): any[] | undefined;

package/types/print/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * print处理相关
+ * @packageDocumentation
+ * @module Print
+ * @preferred
+ */
+/**
+ * 打印指定 HTML
+ * @param {*} html
+ */
+export default function printHtml(html: any): void;