sculp-js 1.5.0 → 1.6.1

package/lib/index.d.ts

@@ -9,6 +9,20 @@ type AnyObject = Record<string | number, any>;
 type PartialDeep<T> = {
     [P in keyof T]?: PartialDeep<T[P]>;
 };
+/**
+ * 判断对象内是否有该静态属性
+ * @param {object} obj
+ * @param {string} key
+ * @returns {boolean}
+ */
+declare function objectHas<T extends AnyObject>(obj: T, key: keyof T): boolean;
+/**
+ * 判断一个对象是否为类数组
+ *
+ * @param any
+ * @returns {boolean}
+ */
+declare function arrayLike(any: unknown): boolean;
 /**
  * 判断任意值的数据类型
  * @param {unknown} any
@@ -42,14 +56,37 @@ declare const isRegExp: (any: unknown) => any is RegExp;
  * @return {Object | boolean}
  */
 declare function isJsonString(str: string): Object | boolean;
-
 /**
- * 判断一个对象是否为类数组
+ * Checks if `value` is an empty object, collection, map, or set.
  *
- * @param any
- * @returns {boolean}
+ * Objects are considered empty if they have no own enumerable string keyed
+ * properties.
+ *
+ * Array-like values such as `arguments` objects, arrays, buffers, strings, or
+ * jQuery-like collections are considered empty if they have a `length` of `0`.
+ * Similarly, maps and sets are considered empty if they have a `size` of `0`.
+ *
+ * @param {*} value The value to check.
+ * @returns {boolean} Returns `true` if `value` is empty, else `false`.
+ * @example
+ *
+ * _.isEmpty(null);
+ * // => true
+ *
+ * _.isEmpty(true);
+ * // => true
+ *
+ * _.isEmpty(1);
+ * // => true
+ *
+ * _.isEmpty([1, 2, 3]);
+ * // => false
+ *
+ * _.isEmpty({ 'a': 1 });
+ * // => false
  */
-declare function arrayLike(any: unknown): boolean;
+declare function isEmpty(value: any): boolean;
+
 /**
  * 遍历数组，返回 false 中断遍历(支持continue和break操作)
  *
@@ -156,7 +193,6 @@ declare function dateToEnd(value: DateValue): Date;
  * - DD：日
  * - dd: 日
  * - HH：时（24 小时制）
- * - hh：时（12 小时制）
  * - mm：分
  * - ss：秒
  * - SSS：毫秒
@@ -300,7 +336,7 @@ declare function downloadBlob(blob: Blob, filename: string, callback?: Function)
  * @param {string} filename
  * @param {Function} callback
  */
-declare function crossDomainDownload(url: string, filename: string, callback?: Function): void;
+declare function crossOriginDownload(url: string, filename: string, callback?: Function): void;
 type FileType = 'json' | 'csv' | 'xls' | 'xlsx';
 /**
  * 将指定数据格式通过 A 链接的方式下载
@@ -317,13 +353,6 @@ declare function downloadData(data: AnyObject | AnyObject[], fileType: FileType,
  * @returns {boolean}
  */
 declare const isPlainObject: (obj: unknown) => boolean;
-/**
- * 判断对象内是否有该静态属性
- * @param {object} obj
- * @param {string} key
- * @returns {boolean}
- */
-declare function objectHas<T extends AnyObject>(obj: T, key: keyof T): boolean;
 /**
  * 遍历对象，返回 false 中断遍历
  * @param {O} obj
@@ -616,7 +645,7 @@ declare const once: <F extends AnyFunc = AnyFunc>(func: F) => OnceFunc<F>;
  */
 declare function setGlobal(key: string | number | symbol, val?: any): void;
 /**
- * 设置全局变量
+ * 获取全局变量
  * @param {string | number | symbol} key
  * @param val
  */
@@ -829,6 +858,41 @@ declare function flatTree(treeList: any[], options?: IFieldOptions): any[];
  */
 declare function fuzzySearchTree(nodes: any[], query: string, options?: ISearchTreeOpts): any[];
 
+/**
+ * 数值安全乘法
+ * @param arg1 数值1
+ * @param arg2 数值2
+ */
+declare const multiply: (arg1: number, arg2: number) => number;
+/**
+ * 数值安全加法
+ * @param arg1 数值1
+ * @param arg2 数值2
+ */
+declare const add: (arg1: number, arg2: number) => number;
+/**
+ * 数值安全减法
+ * @param arg1 数值1
+ * @param arg2 数值2
+ */
+declare const subtract: (arg1: number, arg2: number) => number;
+/**
+ * 数值安全除法
+ * @param arg1 数值1
+ * @param arg2 数值2
+ */
+declare const divide: (arg1: number, arg2: number) => number;
+type NumberType = number | string;
+/**
+ * Correct the given number to specifying significant digits.
+ *
+ * @param num The input number
+ * @param precision An integer specifying the number of significant digits
+ *
+ * @example strip(0.09999999999999998) === 0.1 // true
+ */
+declare function strip(num: NumberType, precision?: number): number;
+
 /**
  * 字符串编码成Base64 （适用于任何环境，包括小程序）
  * @param {string} string
@@ -842,4 +906,17 @@ declare function weBtoa(string: string): string;
  */
 declare function weAtob(string: string): string;
 
-export { type AnyArray, type AnyFunc, type AnyObject, type ArrayElements, type DateObj, type DateValue, type DebounceFunc, type FileType, HEX_POOL, type ICanvasWM, type ICompressOptions, type IFieldOptions, type ISearchTreeOpts, type ITreeConf, type IdLike, type LooseParamValue, type LooseParams, type ObjectAssignItem, type OnceFunc, type Params, type PartialDeep, type RandomString, type ReadyCallback, type Replacer, STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_POOL, STRING_UPPERCASE_ALPHA, type SetStyle, type SmoothScrollOptions, type Style, type ThrottleFunc, UNIQUE_NUMBER_SAFE_LENGTH, type UniqueString, type Url, type WithChildren, addClass, arrayEach, arrayEachAsync, arrayInsertBefore, arrayLike, arrayRemove, asyncMap, buildTree, calculateDate, calculateDateTime, chooseLocalFile, cloneDeep, compressImg, cookieDel, cookieGet, cookieSet, copyText, crossDomainDownload, dateParse, dateToEnd, dateToStart, debounce, downloadBlob, downloadData, downloadHref, downloadURL, flatTree, forEachDeep, forEachMap, formatDate, formatNumber, formatTree, fuzzySearchTree, genCanvasWM, getComputedCssVal, getGlobal, getStrWidthPx, getStyle, hasClass, isArray, isBigInt, isBoolean, isDate, isDomReady, isError, isFunction, isJsonString, isNaN, isNull, isNullOrUnDef, isNumber, isObject, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, isValidDate, numberAbbr, numberToHex, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick, onDomReady, once, parseQueryParams, pathJoin, pathNormalize, qsParse, qsStringify, randomNumber, randomString, randomUuid, removeClass, searchTreeById, setGlobal, setStyle, smoothScroll, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase, supportCanvas, throttle, tooltipEvent, typeIs, uniqueNumber, uniqueString, urlDelParams, urlParse, urlSetParams, urlStringify, wait, weAtob, weBtoa };
+/**
+ * 将base64编码的字符串转换为原始字符串，包括对中文内容的处理(高性能，且支持Web、Node、小程序等任意平台)
+ * @param base64 base64编码的字符串
+ * @returns 原始字符串，包括中文内容
+ */
+declare function decodeFromBase64(base64: string): string;
+/**
+ * 将原始字符串，包括中文内容，转换为base64编码的字符串(高性能，且支持Web、Node、小程序等任意平台)
+ * @param rawStr 原始字符串，包括中文内容
+ * @returns base64编码的字符串
+ */
+declare function encodeToBase64(rawStr: string): string;
+
+export { type AnyArray, type AnyFunc, type AnyObject, type ArrayElements, type DateObj, type DateValue, type DebounceFunc, type FileType, HEX_POOL, type ICanvasWM, type ICompressOptions, type IFieldOptions, type ISearchTreeOpts, type ITreeConf, type IdLike, type LooseParamValue, type LooseParams, type ObjectAssignItem, type OnceFunc, type Params, type PartialDeep, type RandomString, type ReadyCallback, type Replacer, STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_POOL, STRING_UPPERCASE_ALPHA, type SetStyle, type SmoothScrollOptions, type Style, type ThrottleFunc, UNIQUE_NUMBER_SAFE_LENGTH, type UniqueString, type Url, type WithChildren, add, addClass, arrayEach, arrayEachAsync, arrayInsertBefore, arrayLike, arrayRemove, asyncMap, buildTree, calculateDate, calculateDateTime, chooseLocalFile, cloneDeep, compressImg, cookieDel, cookieGet, cookieSet, copyText, crossOriginDownload, dateParse, dateToEnd, dateToStart, debounce, decodeFromBase64, divide, downloadBlob, downloadData, downloadHref, downloadURL, encodeToBase64, flatTree, forEachDeep, forEachMap, formatDate, formatNumber, formatTree, fuzzySearchTree, genCanvasWM, getComputedCssVal, getGlobal, getStrWidthPx, getStyle, hasClass, isArray, isBigInt, isBoolean, isDate, isDomReady, isEmpty, isError, isFunction, isJsonString, isNaN, isNull, isNullOrUnDef, isNumber, isObject, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, isValidDate, multiply, numberAbbr, numberToHex, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick, onDomReady, once, parseQueryParams, pathJoin, pathNormalize, qsParse, qsStringify, randomNumber, randomString, randomUuid, removeClass, searchTreeById, setGlobal, setStyle, smoothScroll, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase, strip, subtract, supportCanvas, throttle, tooltipEvent, typeIs, uniqueNumber, uniqueString, urlDelParams, urlParse, urlSetParams, urlStringify, wait, weAtob, weBtoa };