util-helpers 4.12.0 → 4.12.1

package/types/src/setDataURLPrefix.d.ts

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,21 @@
+export default times;
+/**
+ * 精确乘法，支持多个数相乘
+ *
+ * @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

@@ -0,0 +1,13 @@
+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

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

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

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

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

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

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

@@ -0,0 +1,63 @@
+/**
+ * 值是否为有效的数值
+ *
+ * @param {*} value 待检测的值
+ * @returns {boolean} 是否为有效的数值
+ */
+export function isEffectiveNumeric(value: any): boolean;
+/**
+ * 是否为科学计数法数字
+ *
+ * @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

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,27 @@
+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;

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,11 @@
+export default isType;
+/**
+ * 检测值的 `toString` 类型
+ *
+ * @private
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @param {string} typename 类型名称
+ * @returns {boolean} 返回值的 `toString` 类型是否匹配
+ */
+declare function isType(value: any, typename: string): boolean;

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

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

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

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

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

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