amis-formula 3.1.0 → 3.2.0

package/esm/evalutor.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v3.1.0
+ * amis-formula v3.2.0
  * Copyright 2021-2023 fex
  */
 
@@ -398,14 +398,12 @@ var Evaluator = /** @class */ (function () {
         return result;
     };
     /**
-     * 示例：IF(A, B, C)
+     * 如果满足条件condition，则返回consequent，否则返回alternate，支持多层嵌套IF函数。
      *
-     * 如果满足条件A，则返回B，否则返回C，支持多层嵌套IF函数。
-     *
-     * 也可以用表达式如：A ? B : C
+     * 等价于直接用JS表达式如：condition ? consequent : alternate。
      *
      * @example IF(condition, consequent, alternate)
-     * @param {expression} condition - 条件表达式.
+     * @param {expression} condition 条件表达式。例如：语文成绩>80
      * @param {any} consequent 条件判断通过的返回结果
      * @param {any} alternate 条件判断不通过的返回结果
      * @namespace 逻辑函数
@@ -416,16 +414,16 @@ var Evaluator = /** @class */ (function () {
         return condition() ? trueValue() : falseValue();
     };
     /**
-     * 条件全部符合，返回 true，否则返回 false
+     * 条件全部符合，返回 true，否则返回 false。
      *
-     * 示例：AND(语文成绩>80, 数学成绩>80)
+     * 示例：AND(语文成绩>80, 数学成绩>80)，
      *
-     * 语文成绩和数学成绩都大于 80，则返回 true，否则返回 false
+     * 语文成绩和数学成绩都大于 80，则返回 true，否则返回 false，
      *
-     * 也可以直接用表达式如：语文成绩>80 && 数学成绩>80
+     * 等价于直接用JS表达式如：语文成绩>80 && 数学成绩>80。
      *
      * @example AND(expression1, expression2, ...expressionN)
-     * @param {...expression} conditions - 条件表达式.
+     * @param {...expression} conditions 条件表达式，多个用逗号隔开。例如：语文成绩>80, 数学成绩>80
      * @namespace 逻辑函数
      *
      * @returns {boolean}
@@ -438,16 +436,16 @@ var Evaluator = /** @class */ (function () {
         return condtions.every(function (c) { return c(); });
     };
     /**
-     * 条件任意一个满足条件，返回 true，否则返回 false
+     * 条件任意一个满足条件，返回 true，否则返回 false。
      *
-     * 示例：OR(语文成绩>80, 数学成绩>80)
+     * 示例：OR(语文成绩>80, 数学成绩>80)，
      *
-     * 语文成绩和数学成绩任意一个大于 80，则返回 true，否则返回 false
+     * 语文成绩和数学成绩任意一个大于 80，则返回 true，否则返回 false，
      *
-     * 也可以直接用表达式如：语文成绩>80 || 数学成绩>80
+     * 等价于直接用JS表达式如：语文成绩>80 || 数学成绩>80。
      *
      * @example OR(expression1, expression2, ...expressionN)
-     * @param {...expression} conditions - 条件表达式.
+     * @param {...expression} conditions 条件表达式，多个用逗号隔开。例如：语文成绩>80, 数学成绩>80
      * @namespace 逻辑函数
      *
      * @returns {boolean}
@@ -462,9 +460,12 @@ var Evaluator = /** @class */ (function () {
     /**
      * 异或处理，多个表达式组中存在奇数个真时认为真。
      *
-     * @example XOR(condition1, condition2)
-     * @param {expression} condition1 - 条件表达式1
-     * @param {expression} condition2 - 条件表达式2
+     * 示例：XOR(语文成绩 > 80, 数学成绩 > 80, 英语成绩 > 80)
+     *
+     * 三门成绩中有一门或者三门大于 80，则返回 true，否则返回 false。
+     *
+     * @example XOR(condition1, condition2, ...expressionN)
+     * @param {...expression} condition 条件表达式，多个用逗号隔开。例如：语文成绩>80, 数学成绩>80
      * @namespace 逻辑函数
      *
      * @returns {boolean}
@@ -479,12 +480,13 @@ var Evaluator = /** @class */ (function () {
     /**
      * 判断函数集合，相当于多个 else if 合并成一个。
      *
-     * 示例：IFS(语文成绩 > 80, "优秀", 语文成绩 > 60, "良", "继续努力")
+     * 示例：IFS(语文成绩 > 80, "优秀", 语文成绩 > 60, "良", "继续努力")，
      *
      * 如果语文成绩大于 80，则返回优秀，否则判断大于 60 分，则返回良，否则返回继续努力。
      *
      * @example IFS(condition1, result1, condition2, result2,...conditionN, resultN)
-     * @param {...any} args - 条件，返回值集合
+     * @param {...expression} condition 条件表达式
+     * @param {...any} result 返回值
      * @namespace 逻辑函数
      * @returns {any} 第一个满足条件的结果，没有命中的返回 false。
      */
@@ -506,7 +508,7 @@ var Evaluator = /** @class */ (function () {
         return;
     };
     /**
-     * 返回传入数字的绝对值
+     * 返回传入数字的绝对值。
      *
      * @example ABS(num)
      * @param {number} num - 数值
@@ -519,7 +521,7 @@ var Evaluator = /** @class */ (function () {
         return Math.abs(a);
     };
     /**
-     * 获取最大值，如果只有一个参数且是数组，则计算这个数组内的值
+     * 获取最大值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example MAX(num1, num2, ...numN)
      * @param {...number} num - 数值
@@ -537,7 +539,7 @@ var Evaluator = /** @class */ (function () {
         return Math.max.apply(Math, arr.map(function (item) { return _this.formatNumber(item); }));
     };
     /**
-     * 获取最小值，如果只有一个参数且是数组，则计算这个数组内的值
+     * 获取最小值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example MIN(num1, num2, ...numN)
      * @param {...number} num - 数值
@@ -555,7 +557,7 @@ var Evaluator = /** @class */ (function () {
         return Math.min.apply(Math, arr.map(function (item) { return _this.formatNumber(item); }));
     };
     /**
-     * 求和，如果只有一个参数且是数组，则计算这个数组内的值
+     * 求和，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example SUM(num1, num2, ...numN)
      * @param {...number} num - 数值
@@ -573,7 +575,7 @@ var Evaluator = /** @class */ (function () {
         return arr.reduce(function (sum, a) { return sum + _this.formatNumber(a) || 0; }, 0);
     };
     /**
-     * 将数值向下取整为最接近的整数
+     * 将数值向下取整为最接近的整数。
      *
      * @example INT(num)
      * @param {number} num - 数值
@@ -585,7 +587,7 @@ var Evaluator = /** @class */ (function () {
         return Math.floor(this.formatNumber(n));
     };
     /**
-     * 返回两数相除的余数，参数 number 是被除数，divisor 是除数
+     * 返回两数相除的余数，参数 number 是被除数，divisor 是除数。
      *
      * @example MOD(num, divisor)
      * @param {number} num - 被除数
@@ -598,7 +600,7 @@ var Evaluator = /** @class */ (function () {
         return this.formatNumber(a) % this.formatNumber(b);
     };
     /**
-     * 圆周率 3.1415...
+     * 圆周率 3.1415...。
      *
      * @example PI()
      * @namespace 数学函数
@@ -613,7 +615,7 @@ var Evaluator = /** @class */ (function () {
      *
      * @example ROUND(num[, numDigits = 2])
      * @param {number} num - 要处理的数字
-     * @param {number} numDigits - 小数位数
+     * @param {number} numDigits - 小数位数，默认为2
      * @namespace 数学函数
      *
      * @returns {number} 传入数值四舍五入后的结果
@@ -634,7 +636,7 @@ var Evaluator = /** @class */ (function () {
      *
      * @example FLOOR(num[, numDigits=2])
      * @param {number} num - 要处理的数字
-     * @param {number} numDigits - 小数位数
+     * @param {number} numDigits - 小数位数，默认为2
      * @namespace 数学函数
      *
      * @returns {number} 传入数值向下取整后的结果
@@ -655,7 +657,7 @@ var Evaluator = /** @class */ (function () {
      *
      * @example CEIL(num[, numDigits=2])
      * @param {number} num - 要处理的数字
-     * @param {number} numDigits - 小数位数
+     * @param {number} numDigits - 小数位数，默认为2
      * @namespace 数学函数
      *
      * @returns {number} 传入数值向上取整后的结果
@@ -684,7 +686,7 @@ var Evaluator = /** @class */ (function () {
         return Math.sqrt(this.formatNumber(n));
     };
     /**
-     * 返回所有参数的平均值，如果只有一个参数且是数组，则计算这个数组内的值
+     * 返回所有参数的平均值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example AVG(num1, num2, ...numN)
      * @param {...number} num - 要处理的数字
@@ -702,7 +704,7 @@ var Evaluator = /** @class */ (function () {
         return (this.fnSUM.apply(this, arr.map(function (item) { return _this.formatNumber(item); })) / arr.length);
     };
     /**
-     * 返回数据点与数据均值点之差（数据偏差）的平方和，如果只有一个参数且是数组，则计算这个数组内的值
+     * 返回数据点与数据均值点之差（数据偏差）的平方和，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example DEVSQ(num1, num2, ...numN)
      * @param {...number} num - 要处理的数字
@@ -741,7 +743,7 @@ var Evaluator = /** @class */ (function () {
         return result;
     };
     /**
-     * 数据点到其算术平均值的绝对偏差的平均值
+     * 数据点到其算术平均值的绝对偏差的平均值。
      *
      * @example AVEDEV(num1, num2, ...numN)
      * @param {...number} num - 要处理的数字
@@ -783,7 +785,7 @@ var Evaluator = /** @class */ (function () {
         return result / nums.length;
     };
     /**
-     * 数据点的调和平均值，如果只有一个参数且是数组，则计算这个数组内的值
+     * 数据点的调和平均值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example HARMEAN(num1, num2, ...numN)
      * @param {...number} num - 要处理的数字
@@ -823,7 +825,7 @@ var Evaluator = /** @class */ (function () {
         return nums.length / den;
     };
     /**
-     * 数据集中第 k 个最大值
+     * 数据集中第 k 个最大值。
      *
      * @example LARGE(array, k)
      * @param {array} nums - 要处理的数字
@@ -846,7 +848,7 @@ var Evaluator = /** @class */ (function () {
         })[k - 1];
     };
     /**
-     * 将数值转为中文大写金额
+     * 将数值转为中文大写金额。
      *
      * @example UPPERMONEY(num)
      * @param {number} num - 要处理的数字
@@ -892,9 +894,9 @@ var Evaluator = /** @class */ (function () {
     /**
      * 返回大于等于 0 且小于 1 的均匀分布随机实数。每一次触发计算都会变化。
      *
-     * 示例：`RAND()*100`
+     * 示例：`RAND()*100`，
      *
-     * 返回 0-100 之间的随机数
+     * 返回 0-100 之间的随机数。
      *
      * @example RAND()
      * @namespace 数学函数
@@ -905,7 +907,7 @@ var Evaluator = /** @class */ (function () {
         return Math.random();
     };
     /**
-     * 取数据最后一个
+     * 取数据最后一个。
      *
      * @example LAST(array)
      * @param {...number} arr - 要处理的数组
@@ -952,7 +954,7 @@ var Evaluator = /** @class */ (function () {
         return text.substring(text.length - len, text.length);
     };
     /**
-     * 计算文本的长度
+     * 计算文本的长度。
      *
      * @example LEN(text)
      * @param {string} text - 要处理的文本
@@ -965,7 +967,7 @@ var Evaluator = /** @class */ (function () {
         return text === null || text === void 0 ? void 0 : text.length;
     };
     /**
-     * 计算文本集合中所有文本的长度
+     * 计算文本集合中所有文本的长度。
      *
      * @example LENGTH(textArr)
      * @param {string[]} textArr - 要处理的文本集合
@@ -981,7 +983,7 @@ var Evaluator = /** @class */ (function () {
         return this.fnLEN.call(this, args);
     };
     /**
-     * 判断文本是否为空
+     * 判断文本是否为空。
      *
      * @example ISEMPTY(text)
      * @param {string} text - 要处理的文本
@@ -993,7 +995,7 @@ var Evaluator = /** @class */ (function () {
         return !text || !String(text).trim();
     };
     /**
-     * 将多个传入值连接成文本
+     * 将多个传入值连接成文本。
      *
      * @example CONCATENATE(text1, text2, ...textN)
      * @param {...string} text - 文本集合
@@ -1011,7 +1013,7 @@ var Evaluator = /** @class */ (function () {
     /**
      * 返回计算机字符集的数字代码所对应的字符。
      *
-     * `CHAR(97)` 等价于 "a"
+     * 示例：`CHAR(97)` 等价于 "a"。
      *
      * @example CHAR(code)
      * @param {number} code - 编码值
@@ -1023,7 +1025,7 @@ var Evaluator = /** @class */ (function () {
         return String.fromCharCode(code);
     };
     /**
-     * 将传入文本转成小写
+     * 将传入文本转成小写。
      *
      * @example LOWER(text)
      * @param {string} text - 文本
@@ -1036,7 +1038,7 @@ var Evaluator = /** @class */ (function () {
         return text.toLowerCase();
     };
     /**
-     * 将传入文本转成大写
+     * 将传入文本转成大写。
      *
      * @example UPPER(text)
      * @param {string} text - 文本
@@ -1049,7 +1051,7 @@ var Evaluator = /** @class */ (function () {
         return text.toUpperCase();
     };
     /**
-     * 将传入文本首字母转成大写
+     * 将传入文本首字母转成大写。
      *
      * @example UPPERFIRST(text)
      * @param {string} text - 文本
@@ -1062,11 +1064,11 @@ var Evaluator = /** @class */ (function () {
         return upperFirst(text);
     };
     /**
-     * 向前补齐文本长度
+     * 向前补齐文本长度。
      *
-     * 示例 `PADSTART("6", 2, "0")`
+     * 示例 `PADSTART("6", 2, "0")`，
      *
-     * 返回 `06`
+     * 返回 `06`。
      *
      * @example PADSTART(text)
      * @param {string} text - 文本
@@ -1081,11 +1083,11 @@ var Evaluator = /** @class */ (function () {
         return padStart(text, num, pad);
     };
     /**
-     * 将文本转成标题
+     * 将文本转成标题。
      *
-     * 示例 `CAPITALIZE("star")`
+     * 示例 `CAPITALIZE("star")`，
      *
-     * 返回 `Star`
+     * 返回 `Star`。
      *
      * @example CAPITALIZE(text)
      * @param {string} text - 文本
@@ -1098,11 +1100,11 @@ var Evaluator = /** @class */ (function () {
         return capitalize(text);
     };
     /**
-     * 对文本进行 HTML 转义
+     * 对文本进行 HTML 转义。
      *
-     * 示例 `ESCAPE("<star>&")`
+     * 示例 `ESCAPE("<star>&")`，
      *
-     * 返回 `&lt;start&gt;&amp;`
+     * 返回 `&lt;start&gt;&amp;`。
      *
      * @example ESCAPE(text)
      * @param {string} text - 文本
@@ -1115,11 +1117,11 @@ var Evaluator = /** @class */ (function () {
         return escape(text);
     };
     /**
-     * 对文本长度进行截断
+     * 对文本长度进行截断。
      *
-     * 示例 `TRUNCATE("amis.baidu.com", 6)`
+     * 示例 `TRUNCATE("amis.baidu.com", 6)`，
      *
-     * 返回 `amis...`
+     * 返回 `amis...`。
      *
      * @example TRUNCATE(text, 6)
      * @param {string} text - 文本
@@ -1133,7 +1135,7 @@ var Evaluator = /** @class */ (function () {
         return truncate(text, { length: length });
     };
     /**
-     *  取在某个分隔符之前的所有字符串
+     *  取在某个分隔符之前的所有字符串。
      *
      * @example  BEFORELAST(text, '.')
      * @param {string} text - 文本
@@ -1148,11 +1150,11 @@ var Evaluator = /** @class */ (function () {
         return text.split(delimiter).slice(0, -1).join(delimiter) || text + '';
     };
     /**
-     * 将文本根据指定片段分割成数组
+     * 将文本根据指定片段分割成数组。
      *
-     * 示例：`SPLIT("a,b,c", ",")`
+     * 示例：`SPLIT("a,b,c", ",")`，
      *
-     * 返回 `["a", "b", "c"]`
+     * 返回 `["a", "b", "c"]`。
      *
      * @example SPLIT(text, ',')
      * @param {string} text - 文本
@@ -1167,7 +1169,7 @@ var Evaluator = /** @class */ (function () {
         return text.split(sep);
     };
     /**
-     * 将文本去除前后空格
+     * 将文本去除前后空格。
      *
      * @example TRIM(text)
      * @param {string} text - 文本
@@ -1180,11 +1182,11 @@ var Evaluator = /** @class */ (function () {
         return text.trim();
     };
     /**
-     * 去除文本中的 HTML 标签
+     * 去除文本中的 HTML 标签。
      *
-     * 示例：`STRIPTAG("<b>amis</b>")`
+     * 示例：`STRIPTAG("<b>amis</b>")`，
      *
-     * 返回：`amis`
+     * 返回：`amis`。
      *
      * @example STRIPTAG(text)
      * @param {string} text - 文本
@@ -1197,11 +1199,11 @@ var Evaluator = /** @class */ (function () {
         return text.replace(/<\/?[^>]+(>|$)/g, '');
     };
     /**
-     * 将字符串中的换行转成 HTML `<br>`，用于简单换行的场景
+     * 将字符串中的换行转成 HTML `<br>`，用于简单换行的场景。
      *
-     * 示例：`LINEBREAK("\n")`
+     * 示例：`LINEBREAK("\n")`，
      *
-     * 返回：`<br/>`
+     * 返回：`<br/>`。
      *
      * @example LINEBREAK(text)
      * @param {string} text - 文本
@@ -1214,7 +1216,7 @@ var Evaluator = /** @class */ (function () {
         return text.replace(/(?:\r\n|\r|\n)/g, '<br/>');
     };
     /**
-     * 判断字符串(text)是否以特定字符串(startString)开始，是则返回 True，否则返回 False
+     * 判断字符串(text)是否以特定字符串(startString)开始，是则返回 true，否则返回 false。
      *
      * @example STARTSWITH(text, '片段')
      * @param {string} text - 文本
@@ -1231,7 +1233,7 @@ var Evaluator = /** @class */ (function () {
         return text.indexOf(search) === 0;
     };
     /**
-     * 判断字符串(text)是否以特定字符串(endString)结束，是则返回 True，否则返回 False
+     * 判断字符串(text)是否以特定字符串(endString)结束，是则返回 true，否则返回 false。
      *
      * @example ENDSWITH(text, '片段')
      * @param {string} text - 文本
@@ -1248,7 +1250,7 @@ var Evaluator = /** @class */ (function () {
         return text.indexOf(search, text.length - search.length) !== -1;
     };
     /**
-     * 判断参数 1 中的文本是否包含参数 2 中的文本。
+     * 判断参数 1 中的文本是否包含参数 2 中的文本，是则返回 true，否则返回 false。
      *
      * @example CONTAINS(text, searchText)
      * @param {string} text - 文本
@@ -1291,7 +1293,7 @@ var Evaluator = /** @class */ (function () {
         return result;
     };
     /**
-     * 对文本进行搜索，返回命中的位置
+     * 对文本进行搜索，返回命中的位置。
      *
      * @example SEARCH(text, search, 0)
      * @param {string} text - 要处理的文本
@@ -1312,7 +1314,7 @@ var Evaluator = /** @class */ (function () {
         return -1;
     };
     /**
-     * 返回文本字符串中从指定位置开始的特定数目的字符
+     * 返回文本字符串中从指定位置开始的特定数目的字符。
      *
      * @example MID(text, from, len)
      * @param {string} text - 要处理的文本
@@ -1327,11 +1329,11 @@ var Evaluator = /** @class */ (function () {
         return text.substring(from, from + len);
     };
     /**
-     * 返回路径中的文件名
+     * 返回路径中的文件名。
      *
-     * 示例：`/home/amis/a.json`
+     * 示例：`/home/amis/a.json`，
      *
-     * 返回：a.json`
+     * 返回：a.json`。
      *
      * @example BASENAME(text)
      * @param {string} text - 要处理的文本
@@ -1347,8 +1349,8 @@ var Evaluator = /** @class */ (function () {
     /**
      * 创建日期对象，可以通过特定格式的字符串，或者数值。
      *
-     * 需要注意的是，其中月份的数值是从0开始的，也就是说，
-     * 如果是12月份，你应该传入数值11。
+     * 需要注意的是，其中月份的数值是从0开始的，
+     * 即如果是12月份，你应该传入数值11。
      *
      * @example DATE(2021, 11, 6, 8, 20, 0)
      * @example DATE('2021-12-06 08:20:00')
@@ -1363,10 +1365,9 @@ var Evaluator = /** @class */ (function () {
         return new Date(year, month, day, hour, minute, second);
     };
     /**
-     * 返回时间的时间戳
+     * 返回时间的时间戳。
      *
      * @example TIMESTAMP(date[, format = "X"])
-     * @example TIMESTAMP(date, 'x')
      * @namespace 日期函数
      * @param {date} date 日期对象
      * @param {string} format 时间戳格式，带毫秒传入 'x'。默认为 'X' 不带毫秒的。
@@ -1377,7 +1378,7 @@ var Evaluator = /** @class */ (function () {
         return parseInt(moment(this.normalizeDate(date)).format(format === 'x' ? 'x' : 'X'), 10);
     };
     /**
-     * 返回今天的日期
+     * 返回今天的日期。
      *
      * @example TODAY()
      * @namespace 日期函数
@@ -1399,11 +1400,11 @@ var Evaluator = /** @class */ (function () {
         return new Date();
     };
     /**
-     * 获取日期的星期几，
+     * 获取日期的星期几。
      *
-     * 示例：
+     * 示例
      *
-     * WEEKDAY('2023-02-27') 得到 1
+     * WEEKDAY('2023-02-27') 得到 1。
      *
      * @example WEEKDAY(date)
      * @namespace 日期函数
@@ -1417,11 +1418,11 @@ var Evaluator = /** @class */ (function () {
         return type === 2 ? md.isoWeekday() : md.weekday();
     };
     /**
-     * 获取年份的星期，即第几周
+     * 获取年份的星期，即第几周。
      *
-     * 示例：
+     * 示例
      *
-     * WEEK('2023-03-05') 得到 10
+     * WEEK('2023-03-05') 得到 10。
      *
      * @example WEEK(date)
      * @namespace 日期函数
@@ -1436,14 +1437,14 @@ var Evaluator = /** @class */ (function () {
         return isISO ? md.isoWeek() : md.week();
     };
     /**
-     * 对日期、日期字符串、时间戳进行格式化
+     * 对日期、日期字符串、时间戳进行格式化。
      *
-     * 示例：
+     * 示例
      *
-     * DATETOSTR('12/25/2022', 'YYYY-MM-DD') 得到 '2022.12.25'
-     * DATETOSTR(1676563200, 'YYYY.MM.DD') 得到 '2023.02.17'
-     * DATETOSTR(1676563200000, 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'
-     * DATETOSTR(DATE('2021-12-21'), 'YYYY.MM.DD hh:mm:ss') 得到 '2021.12.21 08:00:00'
+     * DATETOSTR('12/25/2022', 'YYYY-MM-DD') 得到 '2022.12.25'，
+     * DATETOSTR(1676563200, 'YYYY.MM.DD') 得到 '2023.02.17'，
+     * DATETOSTR(1676563200000, 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'，
+     * DATETOSTR(DATE('2021-12-21'), 'YYYY.MM.DD hh:mm:ss') 得到 '2021.12.21 08:00:00'。
      *
      * @example DATETOSTR(date, 'YYYY-MM-DD')
      * @namespace 日期函数
@@ -1458,16 +1459,16 @@ var Evaluator = /** @class */ (function () {
         return moment(date).format(format);
     };
     /**
-     * 获取日期范围字符串中的开始时间、结束时间
+     * 获取日期范围字符串中的开始时间、结束时间。
      *
      * 示例：
      *
-     * DATERANGESPLIT('1676563200, 1676735999') 得到 [1676563200, 1676735999]
-     * DATERANGESPLIT('1676563200, 1676735999', undefined , 'YYYY.MM.DD hh:mm:ss') 得到 [2023.02.17 12:00:00, 2023.02.18 11:59:59]
-     * DATERANGESPLIT('1676563200, 1676735999', 0 , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'
-     * DATERANGESPLIT('1676563200, 1676735999', 'start' , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'
-     * DATERANGESPLIT('1676563200, 1676735999', 1 , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.18 11:59:59'
-     * DATERANGESPLIT('1676563200, 1676735999', 'end' , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.18 11:59:59'
+     * DATERANGESPLIT('1676563200, 1676735999') 得到 [1676563200, 1676735999]，
+     * DATERANGESPLIT('1676563200, 1676735999', undefined , 'YYYY.MM.DD hh:mm:ss') 得到 [2023.02.17 12:00:00, 2023.02.18 11:59:59]，
+     * DATERANGESPLIT('1676563200, 1676735999', 0 , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'，
+     * DATERANGESPLIT('1676563200, 1676735999', 'start' , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'，
+     * DATERANGESPLIT('1676563200, 1676735999', 1 , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.18 11:59:59'，
+     * DATERANGESPLIT('1676563200, 1676735999', 'end' , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.18 11:59:59'。
      *
      * @example DATERANGESPLIT(date, 'YYYY-MM-DD')
      * @namespace 日期函数
@@ -1500,7 +1501,7 @@ var Evaluator = /** @class */ (function () {
         return dateArr;
     };
     /**
-     * 返回日期的指定范围的开端
+     * 返回日期的指定范围的开端。
      *
      * @namespace 日期函数
      * @example STARTOF(date[unit = "day"])
@@ -1514,7 +1515,8 @@ var Evaluator = /** @class */ (function () {
         return format ? md.format(format) : md.toDate();
     };
     /**
-     * 返回日期的指定范围的末尾
+     * 返回日期的指定范围的末尾。
+     *
      * @namespace 日期函数
      * @example ENDOF(date[unit = "day"])
      * @param {date} date 日期对象
@@ -1552,7 +1554,8 @@ var Evaluator = /** @class */ (function () {
         });
     };
     /**
-     * 返回日期的年份
+     * 返回日期的年份。
+     *
      * @namespace 日期函数
      * @example YEAR(date)
      * @param {date} date 日期对象
@@ -1575,7 +1578,8 @@ var Evaluator = /** @class */ (function () {
         return date.getMonth() + 1;
     };
     /**
-     * 返回日期的天
+     * 返回日期的天。
+     *
      * @namespace 日期函数
      * @example DAY(date)
      * @param {date} date 日期对象
@@ -1586,7 +1590,8 @@ var Evaluator = /** @class */ (function () {
         return date.getDate();
     };
     /**
-     * 返回日期的小时
+     * 返回日期的小时。
+     *
      * @param {date} date 日期对象
      * @namespace 日期函数
      * @example HOUR(date)
@@ -1597,7 +1602,8 @@ var Evaluator = /** @class */ (function () {
         return date.getHours();
     };
     /**
-     * 返回日期的分
+     * 返回日期的分。
+     *
      * @param {date} date 日期对象
      * @namespace 日期函数
      * @example MINUTE(date)
@@ -1608,7 +1614,8 @@ var Evaluator = /** @class */ (function () {
         return date.getMinutes();
     };
     /**
-     * 返回日期的秒
+     * 返回日期的秒。
+     *
      * @param {date} date 日期对象
      * @namespace 日期函数
      * @example SECOND(date)
@@ -1619,7 +1626,8 @@ var Evaluator = /** @class */ (function () {
         return date.getSeconds();
     };
     /**
-     * 返回两个日期相差多少年
+     * 返回两个日期相差多少年。
+     *
      * @param {date} endDate 日期对象
      * @param {date} startDate 日期对象
      * @namespace 日期函数
@@ -1632,7 +1640,8 @@ var Evaluator = /** @class */ (function () {
         return moment(endDate).diff(moment(startDate), 'year');
     };
     /**
-     * 返回两个日期相差多少分钟
+     * 返回两个日期相差多少分钟。
+     *
      * @param {date} endDate 日期对象
      * @param {date} startDate 日期对象
      * @namespace 日期函数
@@ -1645,7 +1654,8 @@ var Evaluator = /** @class */ (function () {
         return moment(endDate).diff(moment(startDate), 'minutes');
     };
     /**
-     * 返回两个日期相差多少天
+     * 返回两个日期相差多少天。
+     *
      * @param {date} endDate 日期对象
      * @param {date} startDate 日期对象
      * @namespace 日期函数
@@ -1658,7 +1668,8 @@ var Evaluator = /** @class */ (function () {
         return moment(endDate).diff(moment(startDate), 'days');
     };
     /**
-     * 返回两个日期相差多少小时
+     * 返回两个日期相差多少小时。
+     *
      * @param {date} endDate 日期对象
      * @param {date} startDate 日期对象
      * @namespace 日期函数
@@ -1671,11 +1682,11 @@ var Evaluator = /** @class */ (function () {
         return moment(endDate).diff(moment(startDate), 'hour');
     };
     /**
-     * 修改日期，对日期进行加减天、月份、年等操作
+     * 修改日期，对日期进行加减天、月份、年等操作。
      *
      * 示例：
      *
-     * DATEMODIFY(A, -2, 'month')
+     * DATEMODIFY(A, -2, 'month')，
      *
      * 对日期 A 进行往前减2月的操作。
      *
@@ -1706,7 +1717,7 @@ var Evaluator = /** @class */ (function () {
         return moment(value, format).toDate();
     };
     /**
-     * 判断两个日期，是否第一个日期在第二个日期的前面
+     * 判断两个日期，是否第一个日期在第二个日期的前面，是则返回 true，否则返回 false。
      *
      * @param {date} a 第一个日期
      * @param {date} b 第二个日期
@@ -1722,7 +1733,7 @@ var Evaluator = /** @class */ (function () {
         return moment(a).isBefore(moment(b), unit);
     };
     /**
-     * 判断两个日期，是否第一个日期在第二个日期的后面
+     * 判断两个日期，是否第一个日期在第二个日期的后面，是则返回 true，否则返回 false。
      *
      * @param {date} a 第一个日期
      * @param {date} b 第二个日期
@@ -1738,9 +1749,9 @@ var Evaluator = /** @class */ (function () {
         return moment(a).isAfter(moment(b), unit);
     };
     /**
-     * 判断日期是否在指定范围内
+     * 判断日期是否在指定范围内，是则返回 true，否则返回 false。
      *
-     * 示例：BETWEENRANGE('2021/12/6', ['2021/12/5','2021/12/7'])
+     * 示例：BETWEENRANGE('2021/12/6', ['2021/12/5','2021/12/7'])。
      *
      * @param {any} date 第一个日期
      * @param {any[]} daterange 日期范围
@@ -1757,7 +1768,7 @@ var Evaluator = /** @class */ (function () {
         return moment(this.normalizeDate(date)).isBetween(range[0], range[1], unit, inclusivity);
     };
     /**
-     * 判断两个日期，是否第一个日期在第二个日期的前面或者相等
+     * 判断两个日期，是否第一个日期在第二个日期的前面或者相等，是则返回 true，否则返回 false。
      *
      * @param {date} a 第一个日期
      * @param {date} b 第二个日期
@@ -1773,7 +1784,7 @@ var Evaluator = /** @class */ (function () {
         return moment(a).isSameOrBefore(moment(b), unit);
     };
     /**
-     * 判断两个日期，是否第一个日期在第二个日期的后面或者相等
+     * 判断两个日期，是否第一个日期在第二个日期的后面或者相等，是则返回 true，否则返回 false。
      *
      * @param {date} a 第一个日期
      * @param {date} b 第二个日期
@@ -1789,7 +1800,7 @@ var Evaluator = /** @class */ (function () {
         return moment(a).isSameOrAfter(moment(b), unit);
     };
     /**
-     * 返回数组的长度
+     * 返回数组的长度。
      *
      * @param {Array<any>} arr 数组
      * @namespace 数组
@@ -1842,7 +1853,7 @@ var Evaluator = /** @class */ (function () {
      *
      * 示例：
      *
-     * ARRAYFINDINDEX([0, 2, false], item => item === 2) 得到 1
+     * ARRAYFINDINDEX([0, 2, false], item => item === 2) 得到 1。
      *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
@@ -1865,7 +1876,7 @@ var Evaluator = /** @class */ (function () {
      *
      * 示例：
      *
-     * ARRAYFIND([0, 2, false], item => item === 2) 得到 2
+     * ARRAYFIND([0, 2, false], item => item === 2) 得到 2。
      *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
@@ -1884,11 +1895,11 @@ var Evaluator = /** @class */ (function () {
     };
     /**
      * 数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
-     * 判断第二个箭头函数是否存在返回为 true 的成员。
+     * 判断第二个箭头函数是否存在返回为 true 的成员，是则返回 true，否则返回 false。
      *
      * 示例：
      *
-     * ARRAYSOME([0, 2, false], item => item === 2) 得到 true
+     * ARRAYSOME([0, 2, false], item => item === 2) 得到 true。
      *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
@@ -1907,7 +1918,7 @@ var Evaluator = /** @class */ (function () {
     };
     /**
      * 数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
-     * 判断第二个箭头函数返回是否都为 true。
+     * 判断第二个箭头函数返回是否都为 true，是则返回 true，否则返回 false。
      *
      * 示例：
      *
@@ -1929,11 +1940,11 @@ var Evaluator = /** @class */ (function () {
         });
     };
     /**
-     * 判断数据中是否存在指定元素
+     * 判断数据中是否存在指定元素。
      *
      * 示例：
      *
-     * ARRAYINCLUDES([0, 2, false], 2) 得到 true
+     * ARRAYINCLUDES([0, 2, false], 2) 得到 true。
      *
      * @param {Array<any>} arr 数组
      * @param {any} item 元素
@@ -1945,11 +1956,11 @@ var Evaluator = /** @class */ (function () {
         return (Array.isArray(arr) ? arr : []).includes(item);
     };
     /**
-     * 数组过滤掉 false、null、0 和 ""
+     * 数组过滤掉 false、null、0 和 ""。
      *
      * 示例：
      *
-     * COMPACT([0, 1, false, 2, '', 3]) 得到 [1, 2, 3]
+     * COMPACT([0, 1, false, 2, '', 3]) 得到 [1, 2, 3]。
      *
      * @param {Array<any>} arr 数组
      * @namespace 数组
@@ -1983,11 +1994,11 @@ var Evaluator = /** @class */ (function () {
         }
     };
     /**
-     * 数组转成字符串
+     * 数组转成字符串。
      *
      * 示例：
      *
-     * JOIN(['a', 'b', 'c'], '=') 得到 'a=b=c'
+     * JOIN(['a', 'b', 'c'], '=') 得到 'a=b=c'。
      *
      * @param {Array<any>} arr 数组
      * @param { String} separator 分隔符
@@ -2005,11 +2016,11 @@ var Evaluator = /** @class */ (function () {
         }
     };
     /**
-     * 数组合并
+     * 数组合并。
      *
      * 示例：
      *
-     * CONCAT(['a', 'b', 'c'], ['1'], ['3']) 得到 ['a', 'b', 'c', '1', '3']
+     * CONCAT(['a', 'b', 'c'], ['1'], ['3']) 得到 ['a', 'b', 'c', '1', '3']。
      *
      * @param {Array<any>} arr 数组
      * @namespace 数组
@@ -2027,11 +2038,11 @@ var Evaluator = /** @class */ (function () {
         return arr.reduce(function (a, b) { return a.concat(b); }, []).filter(function (item) { return item; });
     };
     /**
-     * 数组去重，第二个参数「field」，可指定根据该字段去重
+     * 数组去重，第二个参数「field」，可指定根据该字段去重。
      *
      * 示例：
      *
-     * UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]， 'id')
+     * UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]， 'id')。
      *
      * @param {Array<any>} arr 数组
      * @param {string} field 字段
@@ -2044,11 +2055,11 @@ var Evaluator = /** @class */ (function () {
         return field ? uniqBy(arr, field) : uniqWith(arr, isEqual);
     };
     /**
-     * 将JS对象转换成JSON字符串
+     * 将JS对象转换成JSON字符串。
      *
      * 示例：
      *
-     * ENCODEJSON({name: 'amis'}) 得到 '{"name":"amis"}'
+     * ENCODEJSON({name: 'amis'}) 得到 '{"name":"amis"}'。
      *
      * @param {object} obj JS对象
      * @namespace 编码
@@ -2059,11 +2070,11 @@ var Evaluator = /** @class */ (function () {
         return JSON.stringify(obj);
     };
     /**
-     * 解析JSON编码数据，返回JS对象
+     * 解析JSON编码数据，返回JS对象。
      *
      * 示例：
      *
-     * DECODEJSON('{\"name\": "amis"}') 得到 {name: 'amis'}
+     * DECODEJSON('{\"name\": "amis"}') 得到 {name: 'amis'}。
      *
      * @param {string} str 字符串
      * @namespace 编码
@@ -2074,15 +2085,15 @@ var Evaluator = /** @class */ (function () {
         return JSON.parse(str);
     };
     /**
-     * 根据对象或者数组的path路径获取值。 如果解析 value 是 undefined 会以 defaultValue 取代
+     * 根据对象或者数组的path路径获取值。 如果解析 value 是 undefined 会以 defaultValue 取代。
      *
      * 示例：
      *
-     * GET([0, 2, {name: 'amis', age: 18}], 1) 得到 2
-     * GET([0, 2, {name: 'amis', age: 18}], '2.name') 得到 'amis'
-     * GET({arr: [{name: 'amis', age: 18}]}, 'arr[0].name') 得到 'amis'
-     * GET({arr: [{name: 'amis', age: 18}]}, 'arr.0.name') 得到 'amis'
-     * GET({arr: [{name: 'amis', age: 18}]}, 'arr.1.name', 'not-found') 得到 'not-found'
+     * GET([0, 2, {name: 'amis', age: 18}], 1) 得到 2，
+     * GET([0, 2, {name: 'amis', age: 18}], '2.name') 得到 'amis'，
+     * GET({arr: [{name: 'amis', age: 18}]}, 'arr[0].name') 得到 'amis'，
+     * GET({arr: [{name: 'amis', age: 18}]}, 'arr.0.name') 得到 'amis'，
+     * GET({arr: [{name: 'amis', age: 18}]}, 'arr.1.name', 'not-found') 得到 'not-found'。
      *
      * @param {any} obj 对象或数组
      * @param {string} path 路径