util-helpers 4.12.7 → 4.12.8

package/types/src/padZero.d.ts

@@ -1,25 +0,0 @@
-export default padZero;
-/**
- * 前置补零
- *
- * @static
- * @alias module:Processor.padZero
- * @since 4.7.0
- * @param {string|number} value 要处理的值
- * @param {number} [size=2] 指定字符串长度
- * @returns {string} 用零填充数字到给定长度的字符串
- * @example
- * padZero(5); // 05
- * padZero('5'); // 05
- *
- * padZero(12); // 12
- * padZero('12'); // 12
- *
- * padZero(688); // 688
- * padZero('688'); // 688
- *
- * padZero(688, 5); // 00688
- * padZero('688', 5); // 00688
- *
- */
-declare function padZero(value: string | number, size?: number | undefined): string;

package/types/src/parseIdCard.d.ts

@@ -1,107 +0,0 @@
-export default parseIdCard;
-/**
- * - 解析身份证原数据
- */
-export type IdCardOrigin = {
-    /**
-     * - 省份编码
-     */
-    province: string;
-    /**
-     * - 城市编码
-     */
-    city: string;
-    /**
-     * - 地区编码
-     */
-    area: string;
-    /**
-     * - 出生年
-     */
-    year: string;
-    /**
-     * - 出生月
-     */
-    month: string;
-    /**
-     * - 出生日
-     */
-    day: string;
-    /**
-     * - 性别 能整除2为女，否则为男
-     */
-    gender: string;
-};
-/**
- * - 身份证信息
- */
-export type IdCardInfo = {
-    /**
-     * - 省份
-     */
-    province: string;
-    /**
-     * - 生日
-     */
-    birthday: string;
-    /**
-     * - 性别
-     */
-    gender: string;
-    /**
-     * - 解析身份证原数据
-     */
-    origin: IdCardOrigin;
-};
-/**
- * @typedef {Object} IdCardOrigin - 解析身份证原数据
- * @property {string} province - 省份编码
- * @property {string} city - 城市编码
- * @property {string} area - 地区编码
- * @property {string} year - 出生年
- * @property {string} month - 出生月
- * @property {string} day - 出生日
- * @property {string} gender - 性别 能整除2为女，否则为男
- */
-/**
- * @typedef {Object} IdCardInfo - 身份证信息
- * @property {string} province - 省份
- * @property {string} birthday - 生日
- * @property {string} gender - 性别
- * @property {IdCardOrigin} origin - 解析身份证原数据
- */
-/**
- * 解析身份证号码，支持15、18位身份证号码
- *
- * @static
- * @alias module:Processor.parseIdCard
- * @since 4.0.0
- * @see 参考 {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
- * @param {string} id 身份证号码，支持15位
- * @returns {null|IdCardInfo} null 或 省份、生日、性别，省/市/区/年/月/日/性别编码
- * @example
- *
- * parseIdCard('123456789123456'); // null
- *
- * // 18位身份证号码
- * parseIdCard('130701199310302288');
- * // =>
- * {
- *   birthday: "1993-10-30",
- *   gender: "女",
- *   origin: { province: "13", city: "07", area: "01", year: "1993", month: "10", day: "30", gender: "8" },
- *   province: "河北省"
- * }
- *
- * // 15位身份证号码
- * parseIdCard('130701931030228');
- * // =>
- * {
- *   birthday: "93-10-30",
- *   gender: "女",
- *   origin: { province: "13", city: "07", area: "01", year: "93", month: "10", day: "30", gender: "8" },
- *   province: "河北省"
- * }
- *
- */
-declare function parseIdCard(id: string): null | IdCardInfo;

package/types/src/plus.d.ts

@@ -1,17 +0,0 @@
-export default plus;
-/**
- * 精确加法，支持多个数相加，加数默认为 0 。
- *
- * @static
- * @alias module:Math.plus
- * @since 3.1.0
- * @param {...number|string} nums 相加的数
- * @returns {number} 总和
- * @example
- *
- * plus(0.1, 0.2); // 0.3
- * plus(0.1, 0.2, 0.3); // 0.6
- * plus(0.1, 0.2, 0.3, 0.4); // 1
- *
- */
-declare function plus(...nums: (number | string)[]): number;

package/types/src/randomString.d.ts

@@ -1,21 +0,0 @@
-export default randomString;
-/**
- * 生成随机字符串
- *
- * @static
- * @alias module:Other.randomString
- * @since 4.8.0
- * @param {number} [len=0] 长度
- * @param {string} [optionalChars='0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'] 允许的字符，默认为数字和大小写字母
- * @returns {string} 随机字符串
- * @example
- *
- * randomString(5); // slk23
- * randomString(8); // 71mHqo2A
- *
- * // 自定义允许的字符
- * randomString(5, 'abc'); // ccbcb
- * randomString(8, 'abcefg'); // bcgcfabg
- *
- */
-declare function randomString(len?: number | undefined, optionalChars?: string | undefined): string;

package/types/src/replaceChar.d.ts

@@ -1,46 +0,0 @@
-export default replaceChar;
-/**
- * 替换字符，应用场景如：脱敏
- *
- * @static
- * @alias module:Processor.replaceChar
- * @since 1.1.0
- * @param {string} str 要处理的字符串
- * @param {Object} [options] 配置项
- * @param {number} [options.start=3] 开始位置
- * @param {number} [options.end=-4] 结束位置
- * @param {string} [options.char="*"] 替换字符
- * @param {number} [options.repeat] 替换字符的重复次数，默认为替换内容长度，可设置为固定值
- * @param {string} [options.exclude] 排除字符，如果指定排除项，repeat设置无效
- * @returns {string} 处理后的字符
- * @example
- *
- * // 手机号
- * replaceChar('13000000000'); // 130****0000
- *
- * // 身份证
- * replaceChar('130701199310302288'); // 130***********2288
- *
- * // 邮箱
- * const email = '12345@qq.com'
- * replaceChar(email, {start: 2, end: email.indexOf('@'), repeat: 4}); // 12****@qq.com
- *
- * // 银行卡号
- * replaceChar('6228480402564890018', {start: 0, end: -4, repeat: 4}); // ****0018
- *
- * // 带格式的银行卡号，忽略空字符串
- * replaceChar('6228 4804 0256 4890 018', {start: 4, end: -4, exclude: ' '}); // 6228 **** **** **** 018
- *
- * // 用户名
- * replaceChar('林某某', {start: 1, end: Infinity, repeat: 2}); // 林**
- * replaceChar('林某', {start: 1, end: Infinity, repeat: 2}); // 林**
- * replaceChar('林某某某', {start: 1, end: Infinity, repeat: 2}); // 林**
- *
- */
-declare function replaceChar(str: string, { start, end, char, repeat, exclude }?: {
-    start?: number | undefined;
-    end?: number | undefined;
-    char?: string | undefined;
-    repeat?: number | undefined;
-    exclude?: string | undefined;
-} | undefined): string;

package/types/src/round.d.ts

@@ -1,18 +0,0 @@
-export default round;
-/**
- * 四舍五入，支持设置精度
- *
- * @static
- * @alias module:Math.round
- * @since 3.1.0
- * @param {number|string} num 要四舍五入的数字
- * @param {number} [precision=0] 四舍五入的精度
- * @returns {number} 四舍五入的数字
- * @example
- *
- * round(4.006); // 4
- * round(4.006, 2); // 4.01
- * round(4060, -2); // 4100
- *
- */
-declare function round(num: number | string, precision?: number | undefined): number;

package/types/src/safeDate.d.ts

@@ -1,24 +0,0 @@
-export default safeDate;
-/**
- * 创建一个 Date 实例日期对象，同 new Date() 。<br/>
- * 规避了苹果设备浏览器不支持部分格式（YYYY-MM-DD HH-mm 或 YYYY.MM.DD）。
- *
- * @static
- * @alias module:Processor.safeDate
- * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Date|Date}
- * @since 4.4.0
- * @param {string|number|Date} [value] 日期时间字符串、毫秒数、日期对象
- * @param {...number} args 月/日/时/分/秒/毫秒
- * @returns {Date} Date 实例日期对象
- * @example
- *
- * safeDate('2022-1-1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
- * safeDate('2022/1/1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
- * safeDate('2022.1.1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
- * safeDate('2022.1.1 11:11'); // Sat Jan 01 2022 11:11:00 GMT+0800 (中国标准时间)
- * safeDate(99, 1); // Mon Feb 01 1999 00:00:00 GMT+0800 (中国标准时间)
- * safeDate(1646711233171); // Tue Mar 08 2022 11:47:13 GMT+0800 (中国标准时间)
- *
- *
- */
-declare function safeDate(value?: string | number | Date | undefined, ...args: number[]): Date;

package/types/src/setDataURLPrefix.d.ts

@@ -1,26 +0,0 @@
-export default setDataURLPrefix;
-/**
- * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/>
- * 如果你需要获取DataURL 的 MIME 类型和数据本身，推荐使用 <a href="https://www.npmjs.com/package/data-urls">data-urls</a>。
- *
- * @static
- * @alias module:Processor.setDataURLPrefix
- * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Basics_of_HTTP/Data_URIs|Data URLs}
- * @see 参考 {@link https://mimesniff.spec.whatwg.org/#understanding-mime-types|MIME types}
- * @since 4.1.0
- * @param {string} data 数据本身
- * @param {string} [mimetype="image/png"] MIME 类型
- * @param {boolean} [base64=true] 添加 base64 标识
- * @returns {string} DataURL 格式的字符串
- * @example
- *
- * const data = 'PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=';
- * setDataURLPrefix(data); // data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
- * setDataURLPrefix(data, 'image/png', false); // data:image/png,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
- * setDataURLPrefix(data, 'image/jpg'); // data:image/jpg;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
- * setDataURLPrefix(data, 'text/html'); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
- * setDataURLPrefix(data, ''); // data:;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
- * setDataURLPrefix(data, '', false); // data:,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
- *
- */
-declare function setDataURLPrefix(data: string, mimetype?: string | undefined, base64?: boolean | undefined): string;

package/types/src/strlen.d.ts

@@ -1,20 +0,0 @@
-export default strlen;
-/**
- * 获取字符长度。中文汉字占2个字符，英文占1个字符，特殊如emoji占4个字符。
- *
- * @static
- * @alias module:Other.strlen
- * @since 4.10.0
- * @param {string} str 字符串
- * @returns {number} 字符长度
- * @example
- *
- * strlen('你好a'); // 5
- * strlen('你好，世界！'); // 12
- * strlen('严両丞丽'); // 8
- * strlen('abcde'); // 5
- * strlen('𠮷'); // 4
- * strlen('🍎'); // 4
- *
- */
-declare function strlen(str: string): number;

package/types/src/times.d.ts

@@ -1,17 +0,0 @@
-export default times;
-/**
- * 精确乘法，支持多个数相乘，乘数默认为 1 。
- *
- * @static
- * @alias module:Math.times
- * @since 3.1.0
- * @param {...number|string} nums 相乘的数
- * @returns {number} 乘积
- * @example
- *
- * times(3, 0.6); // 1.8
- * times(3, 0.6, 2); // 3.6
- * times(3, 0.6, 2, 10); // 36
- *
- */
-declare function times(...nums: (number | string)[]): number;

package/types/src/utils/config.d.ts

@@ -1,13 +0,0 @@
-export namespace config {
-    const disableWarning: boolean;
-}
-/**
- * 设置禁止warning提示
- * @static
- * @alias module:Debug.formatBankCard
- * @since 3.6.1
- * @param {boolean} bool 是否禁止warning提示
- */
-export function setDisableWarning(bool: boolean): void;
-import { version } from "../../package.json";
-export { version };

package/types/src/utils/constants.d.ts

@@ -1,2 +0,0 @@
-export const MAX_SAFE_INTEGER: number;
-export const MIN_SAFE_INTEGER: number;

package/types/src/utils/convertToString.d.ts

@@ -1,8 +0,0 @@
-export default convertToString;
-/**
- * 转换为字符串
- *
- * @param {*} value 值
- * @returns {string} 字符串
- */
-declare function convertToString(value: any): string;

package/types/src/utils/devWarn.d.ts

@@ -1,7 +0,0 @@
-export default devWarn;
-/**
- * 打印警告信息
- *
- * @param  {any[]} args 打印的信息
- */
-declare function devWarn(...args: any[]): void;

package/types/src/utils/math.util.d.ts

@@ -1,63 +0,0 @@
-/**
- * 将值转换为有效数值
- *
- * @param {*} value 要转换的值
- * @returns {number|string} 有效数值
- */
-export function transformEffectiveNumber(value: any): number | string;
-/**
- * 是否为科学计数法数字
- *
- * @param {string} num 检查值
- * @returns {boolean}
- */
-export function isScientificNumber(num: string): boolean;
-/**
- * 把错误的数据转正
- *
- * @param {number} num 输入数
- * @param {number} [precision=12] 小数点的精度
- * @returns {number}
- * @example
- *
- *  strip(0.09999999999999998)=0.1
- */
-export function strip(num: number, precision?: number | undefined): number;
-/**
- * 计算数字的小数点长度，支持科学记数法
- *
- * @param {number|string} num 输入数
- * @returns {number} 小数点长度
- */
-export function digitLength(num: number | string): number;
-/**
- * 把小数转成整数，支持科学计数法。如果是小数则放大成整数
- *
- * @param {number|string} num 输入数
- * @returns {number}
- */
-export function float2Fixed(num: number | string): number;
-/**
- * 检测数字是否越界，如果越界给出提示
- * @param {number} num 输入数
- * @returns
- */
-export function checkBoundary(num: number): void;
-/**
- * 去掉左边数字0
- *
- * @param {string} num 数字字符串
- * @returns {string}
- */
-export function trimLeftZero(num: string): string;
-/**
- * 科学计数法转换成普通数字
- *
- * JavaScript在以下情景会自动将数值转换为科学计数法：
- *  1.小数点前的数字个数大于等于22位
- *  2.小数点前边是0，小数点后十分位（包含十分位）之后连续零的个数大于等于6个
- *
- * @param {string | number} num 科学计数法数字
- * @returns {string | number} 转换后的数字字符串
- */
-export function scientificToNumber(num: string | number): string | number;

package/types/src/utils/type/index.d.ts

@@ -1,19 +0,0 @@
-import isArguments from "./isArguments";
-import isArray from "./isArray";
-import isBoolean from "./isBoolean";
-import isDate from "./isDate";
-import isError from "./isError";
-import isFunction from "./isFunction";
-import isObject from "./isObject";
-import isNull from "./isNull";
-import isNaN from "./isNaN";
-import isNumber from "./isNumber";
-import isRegExp from "./isRegExp";
-import isString from "./isString";
-import isSymbol from "./isSymbol";
-import isMap from "./isMap";
-import isWeakMap from "./isWeakMap";
-import isSet from "./isSet";
-import isWeakSet from "./isWeakSet";
-import isUndefined from "./isUndefined";
-export { isArguments, isArray, isBoolean, isDate, isError, isFunction, isObject, isNull, isNaN, isNumber, isRegExp, isString, isSymbol, isMap, isWeakMap, isSet, isWeakSet, isUndefined };

package/types/src/utils/type/isArguments.d.ts

@@ -1,18 +0,0 @@
-export default isArguments;
-/**
- * 检查值是否为Arguments
- *
- * @static
- * @alias module:Type.isArguments
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Arguments
- * @example
- *
- * isArguments(function() { return arguments }())
- * // => true
- *
- * isArguments([1, 2, 3])
- * // => false
- */
-declare function isArguments(value: any): boolean;

package/types/src/utils/type/isArray.d.ts

@@ -1,18 +0,0 @@
-export default isArray;
-/**
- * 检查值是否为Array
- *
- * @static
- * @alias module:Type.isArray
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Array
- * @example
- *
- * isArray([])
- * // => true
- *
- * isArray(1)
- * // => false
- */
-declare function isArray(value: any): boolean;

package/types/src/utils/type/isBoolean.d.ts

@@ -1,18 +0,0 @@
-export default isBoolean;
-/**
- * 检查值是否为Boolean
- *
- * @static
- * @alias module:Type.isBoolean
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Boolean
- * @example
- *
- * isBoolean(false)
- * // => true
- *
- * isBoolean(null)
- * // => false
- */
-declare function isBoolean(value: any): boolean;

package/types/src/utils/type/isDate.d.ts

@@ -1,18 +0,0 @@
-export default isDate;
-/**
- * 检查值是否为Date
- *
- * @static
- * @alias module:Type.isDate
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Date
- * @example
- *
- * isDate(new Date)
- * // => true
- *
- * isDate('Mon April 23 2012')
- * // => false
- */
-declare function isDate(value: any): boolean;

package/types/src/utils/type/isError.d.ts

@@ -1,18 +0,0 @@
-export default isError;
-/**
- * 检查值是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError|DOMException
- *
- * @static
- * @alias module:Type.isError
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError|DOMException
- * @example
- *
- * isError(new Error)
- * // => true
- *
- * isError(Error)
- * // => false
- */
-declare function isError(value: any): boolean;

package/types/src/utils/type/isFunction.d.ts

@@ -1,18 +0,0 @@
-export default isFunction;
-/**
- * 检查值是否为Function|AsyncFunction|GeneratorFunction|Proxy
- *
- * @static
- * @alias module:Type.isFunction
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Function|AsyncFunction|GeneratorFunction|Proxy
- * @example
- *
- * isFunction(()=>{}))
- * // => true
- *
- * isFunction(/abc/)
- * // => false
- */
-declare function isFunction(value: any): boolean;

package/types/src/utils/type/isMap.d.ts

@@ -1,18 +0,0 @@
-export default isMap;
-/**
- * 检查值是否为Map
- *
- * @static
- * @alias module:Type.isMap
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Map
- * @example
- *
- * isMap(new Map)
- * // => true
- *
- * isMap(new WeakMap)
- * // => false
- */
-declare function isMap(value: any): boolean;

package/types/src/utils/type/isNaN.d.ts

@@ -1,18 +0,0 @@
-export default _isNaN;
-/**
- * 检查值是否为NaN
- *
- * @static
- * @alias module:Type.isNaN
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为NaN
- * @example
- *
- * isNaN(NaN)
- * // => true
- *
- * isNaN(1)
- * // => false
- */
-declare function _isNaN(value: any): boolean;

package/types/src/utils/type/isNil.d.ts

@@ -1,11 +0,0 @@
-export default isNil;
-/**
- * 检查值是否为 undefined 或 null
- *
- * @static
- * @alias module:Type.isNaN
- * @since 4.3.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为 undefined 或 null
- */
-declare function isNil(value: any): boolean;

package/types/src/utils/type/isNull.d.ts

@@ -1,18 +0,0 @@
-export default isNull;
-/**
- * 检查值是否为Null
- *
- * @static
- * @alias module:Type.isNull
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Null
- * @example
- *
- * isNull(null)
- * // => true
- *
- * isNull(void 0)
- * // => false
- */
-declare function isNull(value: any): boolean;

package/types/src/utils/type/isNumber.d.ts

@@ -1,27 +0,0 @@
-export default isNumber;
-/**
- * 检查值是否为Number
- *
- * @static
- * @alias module:Type.isNumber
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Number
- * @example
- *
- * isNumber(1)
- * // => true
- *
- * isNumber(Number.MIN_VALUE)
- * // => true
- *
- * isNumber(Infinity)
- * // => true
- *
- * isNumber(NaN)
- * // => true
- *
- * isNumber('1')
- * // => false
- */
-declare function isNumber(value: any): boolean;