sculp-js 1.5.1 → 1.7.0

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
@@ -39,17 +53,40 @@ declare const isRegExp: (any: unknown) => any is RegExp;
 /**
  * 判断一个字符串是否为有效的 JSON, 若有效则返回有效的JSON对象，否则false
  * @param {string} str
- * @return {Object | boolean}
+ * @returns {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：毫秒
@@ -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
@@ -463,7 +492,7 @@ declare const stringFill: (length: number, value?: string) => string;
 /**
  * 解析URL查询参数
  * @param {string} searchStr
- * @return {Record<string, string | string[]>}
+ * @returns {Record<string, string | string[]>}
  */
 declare function parseQueryParams(searchStr?: string): Record<string, string | string[]>;
 
@@ -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
  */
@@ -817,7 +846,7 @@ declare function formatTree(list: any[], options?: IFieldOptions): any[];
  * 树形结构转扁平化
  * @param {any} treeList
  * @param {IFieldOptions} options
- * @return {*}
+ * @returns {*}
  */
 declare function flatTree(treeList: any[], options?: IFieldOptions): any[];
 /**
@@ -825,21 +854,207 @@ declare function flatTree(treeList: any[], options?: IFieldOptions): any[];
  * @param {any[]} nodes
  * @param {string} query
  * @param {ISearchTreeOpts} options
- * @return {any[]}
+ * @returns {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
- * @return {string}
+ * @returns {string}
  */
 declare function weBtoa(string: string): string;
 /**
  * Base64解码为原始字符串（适用于任何环境，包括小程序）
  * @param {string} string
- * @return {string}
+ * @returns {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, crossOriginDownload, 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;
+
+declare const EMAIL_REGEX: RegExp;
+/**
+ * 判断字符串是否为邮箱格式，不对邮箱真实性做验证，如域名是否正确等
+ * @param {string} value
+ * @returns {boolean}
+ */
+declare const isEmail: (value: string) => boolean;
+declare const PHONE_REGEX: RegExp;
+/**
+ * 判断字符串是否为宽松手机格式，即首位为 1 的 11 位数字都属于手机号
+ * @param {string} value
+ * @returns {boolean}
+ */
+declare const isPhone: (value: string) => boolean;
+/**
+ * 判断字符串是否为身份证号码格式
+ * @param {string} value
+ * @returns {boolean}
+ */
+declare const isIdNo: (value: string) => boolean;
+declare const URL_REGEX: RegExp;
+declare const HTTP_URL_REGEX: RegExp;
+/**
+ * 判断字符串是否为 url 格式，支持 http、https、ftp 协议，支持域名或者 ipV4
+ * @param {string} value
+ * @returns {boolean}
+ */
+declare const isUrl: (url: string, includeFtp?: boolean) => boolean;
+declare const IPV4_REGEX: RegExp;
+declare const IPV6_REGEX: RegExp;
+/**
+ * 判断字符串是否为 IPV4 格式，不对 ip 真实性做验证
+ * @param {string} value
+ * @returns {boolean}
+ */
+declare const isIpV4: (value: string) => boolean;
+/**
+ * 判断字符串是否为 IPV6 格式，不对 ip 真实性做验证
+ * @param {string} value
+ * @returns {boolean}
+ */
+declare const isIpV6: (value: string) => boolean;
+/**
+ * 判断字符串是否为整数（自然数），即 ...,-3,-2,-1,0,1,2,3,...
+ * @param {string} value
+ * @returns {boolean}
+ */
+declare const isInteger: (value: string) => boolean;
+/**
+ * 判断字符串是否为浮点数，即必须有小数点的有理数
+ * @param {string} value
+ * @returns {boolean}
+ */
+declare const isFloat: (value: string) => boolean;
+/**
+ * 判断字符串是否为正确数值，包括整数和浮点数
+ * @param {string} value
+ * @returns {boolean}
+ */
+declare const isNumerical: (value: string) => boolean;
+/**
+ * 判断字符串是否为数字，例如六位数字短信验证码（093031）
+ * @param {string} value
+ * @returns {boolean}
+ */
+declare const isDigit: (value: string) => boolean;
+
+/**
+ * 去除字符串中重复字符
+ * @param {string} str
+ * @returns string
+ * @example
+ *
+ * uniqueSymbol('1a1bac');
+ * // => '1abc'
+ */
+declare function uniqueSymbol(str: string): string;
+/**
+ * 转义所有特殊字符
+ * @param {string} str 原字符串
+ *  reference: https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Guide/Regular_expressions
+ * @returns string
+ */
+declare function escapeRegExp(str: string): string;
+/**
+ * 解析字符串的插值变量
+ * @param {string} str 字符串
+ * @param {string} leftMatchSymbol 变量左侧匹配符号，默认：{
+ * @param {string} rightMatchSymbol 变量右侧匹配符号，默认：}
+ * @returns string[]
+ * @example
+ *
+ * default match symbol {} same as /{\s*([^{}\s]*)\s*}/g
+ */
+declare function parseVarFromString(str: string, leftMatchSymbol?: string, rightMatchSymbol?: string): string[];
+/**
+ * 替换字符串中的插值变量
+ * @param {string} sourceStr
+ * @param {Record<string, any>} targetObj
+ * @param {string} leftMatchSymbol 变量左侧匹配符号，默认：{
+ * @param {string} rightMatchSymbol 变量右侧匹配符号，默认：}
+ * @returns string
+ */
+declare function replaceVarFromString(sourceStr: string, targetObj: Record<string, any>, leftMatchSymbol?: string, rightMatchSymbol?: string): string;
+/**
+ * 在指定作用域中执行代码
+ * @param {string} code 要执行的代码（需包含 return 语句或表达式）
+ * @param {Object} scope 作用域对象（键值对形式的变量环境）
+ * @returns 代码执行结果
+ *
+ * @example
+ * // 测试用例 1: 基本变量访问
+ * executeInScope("return a + b;", { a: 1, b: 2 });
+ * // 3
+ *
+ * // 测试用例 2: 支持复杂表达式和运算
+ * executeInScope(
+ * "return Array.from({ length: 3 }, (_, i) => base + i);",
+ * { base: 100 }
+ * );
+ * // [100, 101, 102]
+ *
+ * // 支持外传函数作用域执行
+ * const scope = {
+ *  $: {
+ *    fun: {
+ *      time: {
+ *        now: function () {
+ *          return new Date();
+ *        },
+ *      },
+ *    },
+ *  },
+ * };
+ * executeInScope("return $.fun.time.now()", scope)
+ */
+declare function executeInScope(code: string, scope?: Record<string, any>): any;
+
+export { type AnyArray, type AnyFunc, type AnyObject, type ArrayElements, type DateObj, type DateValue, type DebounceFunc, EMAIL_REGEX, type FileType, HEX_POOL, HTTP_URL_REGEX, type ICanvasWM, type ICompressOptions, type IFieldOptions, IPV4_REGEX, IPV6_REGEX, type ISearchTreeOpts, type ITreeConf, type IdLike, type LooseParamValue, type LooseParams, type ObjectAssignItem, type OnceFunc, PHONE_REGEX, 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, URL_REGEX, 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, escapeRegExp, executeInScope, flatTree, forEachDeep, forEachMap, formatDate, formatNumber, formatTree, fuzzySearchTree, genCanvasWM, getComputedCssVal, getGlobal, getStrWidthPx, getStyle, hasClass, isArray, isBigInt, isBoolean, isDate, isDigit, isDomReady, isEmail, isEmpty, isError, isFloat, isFunction, isIdNo, isInteger, isIpV4, isIpV6, isJsonString, isNaN, isNull, isNullOrUnDef, isNumber, isNumerical, isObject, isPhone, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, isUrl, isValidDate, multiply, numberAbbr, numberToHex, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick, onDomReady, once, parseQueryParams, parseVarFromString, pathJoin, pathNormalize, qsParse, qsStringify, randomNumber, randomString, randomUuid, removeClass, replaceVarFromString, searchTreeById, setGlobal, setStyle, smoothScroll, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase, strip, subtract, supportCanvas, throttle, tooltipEvent, typeIs, uniqueNumber, uniqueString, uniqueSymbol, urlDelParams, urlParse, urlSetParams, urlStringify, wait, weAtob, weBtoa };

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.38.3"
+    }
+  ]
+}