amis-formula 1.2.3 → 1.2.7

package/dist/index.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v1.2.3
+ * amis-formula v1.2.7
  * Copyright 2021 fex
  */
 
@@ -367,10 +367,39 @@ var Evaluator = /** @class */ (function () {
         }
         return fn.apply(this, args);
     };
-    // 逻辑函数
+    /**
+     * 示例：IF(A, B, C)
+     *
+     * 如果满足条件A，则返回B，否则返回C，支持多层嵌套IF函数。
+     *
+     * 也可以用表达式如：A ? B : C
+     *
+     * @example IF(condition, consequent, alternate)
+     * @param {expression} condition - 条件表达式.
+     * @param {any} consequent 条件判断通过的返回结果
+     * @param {any} alternate 条件判断不通过的返回结果
+     * @namespace 逻辑函数
+     *
+     * @returns {any} 根据条件返回不同的结果
+     */
     Evaluator.prototype.fnIF = function (condition, trueValue, falseValue) {
         return condition() ? trueValue() : falseValue();
     };
+    /**
+     * 条件全部符合，返回 true，否则返回 false
+     *
+     * 示例：AND(语文成绩>80, 数学成绩>80)
+     *
+     * 语文成绩和数学成绩都大于 80，则返回 true，否则返回 false
+     *
+     * 也可以直接用表达式如：语文成绩>80 && 数学成绩>80
+     *
+     * @example AND(expression1, expression2, ...expressionN)
+     * @param {...expression} conditions - 条件表达式.
+     * @namespace 逻辑函数
+     *
+     * @returns {boolean}
+     */
     Evaluator.prototype.fnAND = function () {
         var condtions = [];
         for (var _i = 0; _i < arguments.length; _i++) {
@@ -378,6 +407,21 @@ var Evaluator = /** @class */ (function () {
         }
         return condtions.every(function (c) { return c(); });
     };
+    /**
+     * 条件任意一个满足条件，返回 true，否则返回 false
+     *
+     * 示例：OR(语文成绩>80, 数学成绩>80)
+     *
+     * 语文成绩和数学成绩任意一个大于 80，则返回 true，否则返回 false
+     *
+     * 也可以直接用表达式如：语文成绩>80 || 数学成绩>80
+     *
+     * @example OR(expression1, expression2, ...expressionN)
+     * @param {...expression} conditions - 条件表达式.
+     * @namespace 逻辑函数
+     *
+     * @returns {boolean}
+     */
     Evaluator.prototype.fnOR = function () {
         var condtions = [];
         for (var _i = 0; _i < arguments.length; _i++) {
@@ -385,9 +429,31 @@ var Evaluator = /** @class */ (function () {
         }
         return condtions.some(function (c) { return c(); });
     };
+    /**
+     * 异或处理，两个表达式同时为「真」，或者同时为「假」，则结果返回为「真」
+     *
+     * @example XOR(condition1, condition2)
+     * @param {expression} condition1 - 条件表达式1
+     * @param {expression} condition2 - 条件表达式2
+     * @namespace 逻辑函数
+     *
+     * @returns {boolean}
+     */
     Evaluator.prototype.fnXOR = function (c1, c2) {
         return !!c1() === !!c2();
     };
+    /**
+     * 判断函数集合，相当于多个 else if 合并成一个。
+     *
+     * 示例：IFS(语文成绩 > 80, "优秀", 语文成绩 > 60, "良", "继续努力")
+     *
+     * 如果语文成绩大于 80，则返回优秀，否则判断大于 60 分，则返回良，否则返回继续努力。
+     *
+     * @example IFS(condition1, result1, condition2, result2,...conditionN, resultN)
+     * @param {...any} args - 条件，返回值集合
+     * @namespace 逻辑函数
+     * @returns {any} 第一个满足条件的结果，没有命中的返回 false。
+     */
     Evaluator.prototype.fnIFS = function () {
         var args = [];
         for (var _i = 0; _i < arguments.length; _i++) {
@@ -405,11 +471,28 @@ var Evaluator = /** @class */ (function () {
         }
         return;
     };
-    // 数学函数
+    /**
+     * 返回传入数字的绝对值
+     *
+     * @example ABS(num)
+     * @param {number} num - 数值
+     * @namespace 数学函数
+     *
+     * @returns {number} 传入数值的绝对值
+     */
     Evaluator.prototype.fnABS = function (a) {
         a = this.formatNumber(a);
         return Math.abs(a);
     };
+    /**
+     * 获取最大值
+     *
+     * @example MAX(num1, num2, ...numN)
+     * @param {...number} num - 数值
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有传入值中最大的那个
+     */
     Evaluator.prototype.fnMAX = function () {
         var _this = this;
         var args = [];
@@ -418,6 +501,15 @@ var Evaluator = /** @class */ (function () {
         }
         return Math.max.apply(Math, args.map(function (item) { return _this.formatNumber(item); }));
     };
+    /**
+     * 获取最小值
+     *
+     * @example MIN(num1, num2, ...numN)
+     * @param {...number} num - 数值
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有传入值中最小的那个
+     */
     Evaluator.prototype.fnMIN = function () {
         var _this = this;
         var args = [];
@@ -426,6 +518,15 @@ var Evaluator = /** @class */ (function () {
         }
         return Math.min.apply(Math, args.map(function (item) { return _this.formatNumber(item); }));
     };
+    /**
+     * 求和
+     *
+     * @example SUM(num1, num2, ...numN)
+     * @param {...number} num - 数值
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有传入数值的总和
+     */
     Evaluator.prototype.fnSUM = function () {
         var _this = this;
         var args = [];
@@ -434,15 +535,52 @@ var Evaluator = /** @class */ (function () {
         }
         return args.reduce(function (sum, a) { return sum + _this.formatNumber(a) || 0; }, 0);
     };
+    /**
+     * 将数值向下取整为最接近的整数
+     *
+     * @example INT(num)
+     * @param {number} num - 数值
+     * @namespace 数学函数
+     *
+     * @returns {number} 数值对应的整形
+     */
     Evaluator.prototype.fnINT = function (n) {
         return Math.floor(this.formatNumber(n));
     };
+    /**
+     * 返回两数相除的余数，参数 number 是被除数，divisor 是除数
+     *
+     * @example MOD(num, divisor)
+     * @param {number} num - 被除数
+     * @param {number} divisor - 除数
+     * @namespace 数学函数
+     *
+     * @returns {number} 两数相除的余数
+     */
     Evaluator.prototype.fnMOD = function (a, b) {
         return this.formatNumber(a) % this.formatNumber(b);
     };
+    /**
+     * 圆周率 3.1415...
+     *
+     * @example PI()
+     * @namespace 数学函数
+     *
+     * @returns {number} 圆周率数值
+     */
     Evaluator.prototype.fnPI = function () {
         return Math.PI;
     };
+    /**
+     * 将数字四舍五入到指定的位数，可以设置小数位。
+     *
+     * @example ROUND(num[, numDigits = 2])
+     * @param {number} num - 要处理的数字
+     * @param {number} numDigits - 小数位数
+     * @namespace 数学函数
+     *
+     * @returns {number} 传入数值四舍五入后的结果
+     */
     Evaluator.prototype.fnROUND = function (a, b) {
         a = this.formatNumber(a);
         b = this.formatNumber(b);
@@ -453,6 +591,16 @@ var Evaluator = /** @class */ (function () {
         }
         return Math.round(a);
     };
+    /**
+     * 将数字向下取整到指定的位数，可以设置小数位。
+     *
+     * @example FLOOR(num[, numDigits=2])
+     * @param {number} num - 要处理的数字
+     * @param {number} numDigits - 小数位数
+     * @namespace 数学函数
+     *
+     * @returns {number} 传入数值向下取整后的结果
+     */
     Evaluator.prototype.fnFLOOR = function (a, b) {
         a = this.formatNumber(a);
         b = this.formatNumber(b);
@@ -463,6 +611,16 @@ var Evaluator = /** @class */ (function () {
         }
         return Math.floor(a);
     };
+    /**
+     * 将数字向上取整到指定的位数，可以设置小数位。
+     *
+     * @example CEIL(num[, numDigits=2])
+     * @param {number} num - 要处理的数字
+     * @param {number} numDigits - 小数位数
+     * @namespace 数学函数
+     *
+     * @returns {number} 传入数值向上取整后的结果
+     */
     Evaluator.prototype.fnCEIL = function (a, b) {
         a = this.formatNumber(a);
         b = this.formatNumber(b);
@@ -473,9 +631,27 @@ var Evaluator = /** @class */ (function () {
         }
         return Math.ceil(a);
     };
+    /**
+     * 开平方，参数 number 为非负数
+     *
+     * @example SQRT(num)
+     * @param {number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {number} 开平方的结果
+     */
     Evaluator.prototype.fnSQRT = function (n) {
         return Math.sqrt(this.formatNumber(n));
     };
+    /**
+     * 返回所有参数的平均值
+     *
+     * @example AVG(num1, num2, ...numN)
+     * @param {...number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有数值的平均值
+     */
     Evaluator.prototype.fnAVG = function () {
         var _this = this;
         var args = [];
@@ -484,6 +660,15 @@ var Evaluator = /** @class */ (function () {
         }
         return (this.fnSUM.apply(this, args.map(function (item) { return _this.formatNumber(item); })) / args.length);
     };
+    /**
+     * 将数值转为中文大写金额
+     *
+     * @example UPPERMONEY(num)
+     * @param {number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {string} 数值中文大写字符
+     */
     Evaluator.prototype.fnUPPERMONEY = function (n) {
         n = this.formatNumber(n);
         var fraction = ['角', '分'];
@@ -514,6 +699,18 @@ var Evaluator = /** @class */ (function () {
                 .replace(/(零.)+/g, '零')
                 .replace(/^整$/, '零元整'));
     };
+    /**
+     * 返回大于等于 0 且小于 1 的均匀分布随机实数。每一次触发计算都会变化。
+     *
+     * 示例：`RAND()*100`
+     *
+     * 返回 0-100 之间的随机数
+     *
+     * @example RAND()
+     * @namespace 数学函数
+     *
+     * @returns {number} 随机数
+     */
     Evaluator.prototype.fnRAND = function () {
         return Math.random();
     };
@@ -524,18 +721,56 @@ var Evaluator = /** @class */ (function () {
         }
         return "".concat(raw);
     };
+    /**
+     * 返回传入文本左侧的指定长度字符串。
+     *
+     * @example LEFT(text, len)
+     * @param {string} text - 要处理的文本
+     * @param {number} len - 要处理的长度
+     * @namespace 文本函数
+     *
+     * @returns {string} 对应字符串
+     */
     Evaluator.prototype.fnLEFT = function (text, len) {
         text = this.normalizeText(text);
         return text.substring(0, len);
     };
+    /**
+     * 返回传入文本右侧的指定长度字符串。
+     *
+     * @example RIGHT(text, len)
+     * @param {string} text - 要处理的文本
+     * @param {number} len - 要处理的长度
+     * @namespace 文本函数
+     *
+     * @returns {string} 对应字符串
+     */
     Evaluator.prototype.fnRIGHT = function (text, len) {
         text = this.normalizeText(text);
         return text.substring(text.length - len, text.length);
     };
+    /**
+     * 计算文本的长度
+     *
+     * @example LEN(text)
+     * @param {string} text - 要处理的文本
+     * @namespace 文本函数
+     *
+     * @returns {number} 长度
+     */
     Evaluator.prototype.fnLEN = function (text) {
         text = this.normalizeText(text);
         return text === null || text === void 0 ? void 0 : text.length;
     };
+    /**
+     * 计算文本集合中所有文本的长度
+     *
+     * @example LENGTH(textArr)
+     * @param {string[]} textArr - 要处理的文本集合
+     * @namespace 文本函数
+     *
+     * @returns {number[]} 长度集合
+     */
     Evaluator.prototype.fnLENGTH = function () {
         var args = [];
         for (var _i = 0; _i < arguments.length; _i++) {
@@ -543,9 +778,27 @@ var Evaluator = /** @class */ (function () {
         }
         return this.fnLEN.call(this, args);
     };
+    /**
+     * 判断文本是否为空
+     *
+     * @example ISEMPTY(text)
+     * @param {string} text - 要处理的文本
+     * @namespace 文本函数
+     *
+     * @returns {boolean} 判断结果
+     */
     Evaluator.prototype.fnISEMPTY = function (text) {
         return !text || !String(text).trim();
     };
+    /**
+     * 将多个传入值连接成文本
+     *
+     * @example CONCATENATE(text1, text2, ...textN)
+     * @param {...string} text - 文本集合
+     * @namespace 文本函数
+     *
+     * @returns {string} 连接后的文本
+     */
     Evaluator.prototype.fnCONCATENATE = function () {
         var args = [];
         for (var _i = 0; _i < arguments.length; _i++) {
@@ -553,26 +806,88 @@ var Evaluator = /** @class */ (function () {
         }
         return args.join('');
     };
+    /**
+     * 返回计算机字符集的数字代码所对应的字符。
+     *
+     * `CHAR(97)` 等价于 "a"
+     *
+     * @example CHAR(code)
+     * @param {number} code - 编码值
+     * @namespace 文本函数
+     *
+     * @returns {string} 指定位置的字符
+     */
     Evaluator.prototype.fnCHAR = function (code) {
         return String.fromCharCode(code);
     };
+    /**
+     * 将传入文本转成小写
+     *
+     * @example LOWER(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
     Evaluator.prototype.fnLOWER = function (text) {
         text = this.normalizeText(text);
         return text.toLowerCase();
     };
+    /**
+     * 将传入文本转成大写
+     *
+     * @example UPPER(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
     Evaluator.prototype.fnUPPER = function (text) {
         text = this.normalizeText(text);
         return text.toUpperCase();
     };
+    /**
+     * 将文本根据指定片段分割成数组
+     *
+     * 示例：`SPLIT("a,b,c", ",")`
+     *
+     * 返回 `["a", "b", "c"]`
+     *
+     * @example SPLIT(text, ',')
+     * @param {string} text - 文本
+     * @param {string} delimiter - 文本片段
+     * @namespace 文本函数
+     *
+     * @returns {Array<string>} 文本集
+     */
     Evaluator.prototype.fnSPLIT = function (text, sep) {
         if (sep === void 0) { sep = ','; }
         text = this.normalizeText(text);
         return text.split(sep);
     };
+    /**
+     * 将文本去除前后空格
+     *
+     * @example TRIM(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 处理后的文本
+     */
     Evaluator.prototype.fnTRIM = function (text) {
         text = this.normalizeText(text);
         return text.trim();
     };
+    /**
+     * 判断字符串(text)是否以特定字符串(startString)开始，是则返回 True，否则返回 False
+     *
+     * @example STARTSWITH(text, '片段')
+     * @param {string} text - 文本
+     * @param {string} startString - 起始文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 判断结果
+     */
     Evaluator.prototype.fnSTARTSWITH = function (text, search) {
         if (!search) {
             return false;
@@ -580,6 +895,16 @@ var Evaluator = /** @class */ (function () {
         text = this.normalizeText(text);
         return text.indexOf(search) === 0;
     };
+    /**
+     * 判断参数 1 中的文本是否包含参数 2 中的文本。
+     *
+     * @example CONTAINS(text, searchText)
+     * @param {string} text - 文本
+     * @param {string} searchText - 搜索文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 判断结果
+     */
     Evaluator.prototype.fnCONTAINS = function (text, search) {
         if (!search) {
             return false;
@@ -587,6 +912,17 @@ var Evaluator = /** @class */ (function () {
         text = this.normalizeText(text);
         return !!~text.indexOf(search);
     };
+    /**
+     * 对文本进行全量替换。
+     *
+     * @example REPLACE(text, search, replace)
+     * @param {string} text - 要处理的文本
+     * @param {string} search - 要被替换的文本
+     * @param {string} replace - 要替换的文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 处理结果
+     */
     Evaluator.prototype.fnREPLACE = function (text, search, replace) {
         text = this.normalizeText(text);
         var result = text;
@@ -602,6 +938,17 @@ var Evaluator = /** @class */ (function () {
         }
         return result;
     };
+    /**
+     * 对文本进行搜索，返回命中的位置
+     *
+     * @example SEARCH(text, search, 0)
+     * @param {string} text - 要处理的文本
+     * @param {string} search - 用来搜索的文本
+     * @param {number} start - 起始位置
+     * @namespace 文本函数
+     *
+     * @returns {number} 命中的位置
+     */
     Evaluator.prototype.fnSEARCH = function (text, search, start) {
         if (start === void 0) { start = 0; }
         text = this.normalizeText(text);
@@ -612,35 +959,111 @@ var Evaluator = /** @class */ (function () {
         }
         return -1;
     };
+    /**
+     * 返回文本字符串中从指定位置开始的特定数目的字符
+     *
+     * @example MID(text, from, len)
+     * @param {string} text - 要处理的文本
+     * @param {number} from - 起始位置
+     * @param {number} len - 处理长度
+     * @namespace 文本函数
+     *
+     * @returns {number} 命中的位置
+     */
     Evaluator.prototype.fnMID = function (text, from, len) {
         text = this.normalizeText(text);
         return text.substring(from, from + len);
     };
     // 日期函数
+    /**
+     * 创建日期对象，可以通过特定格式的字符串，或者数值。
+     *
+     * 需要注意的是，其中月份的数值是从0开始的，也就是说，
+     * 如果是12月份，你应该传入数值11。
+     *
+     * @example DATE(2021, 11, 6, 8, 20, 0)
+     * @example DATE('2021-12-06 08:20:00')
+     * @namespace 日期函数
+     *
+     * @returns {Date} 日期对象
+     */
     Evaluator.prototype.fnDATE = function (year, month, day, hour, minute, second) {
         if (month === undefined) {
             return new Date(year);
         }
         return new Date(year, month, day, hour, minute, second);
     };
+    /**
+     * 返回时间的时间戳
+     *
+     * @example TIMESTAMP(date[, format = "X"])
+     * @namespace 日期函数
+     * @param {date} date 日期对象
+     * @param {string} format 时间戳格式，带毫秒传入 'x'。默认为 'X' 不带毫秒的。
+     *
+     * @returns {number} 时间戳
+     */
     Evaluator.prototype.fnTIMESTAMP = function (date, format) {
         return parseInt(moment__default["default"](date).format(format === 'x' ? 'x' : 'X'), 10);
     };
+    /**
+     * 返回今天的日期
+     *
+     * @example TODAY()
+     * @namespace 日期函数
+     *
+     * @returns {number} 日期
+     */
     Evaluator.prototype.fnTODAY = function () {
         return new Date();
     };
+    /**
+     * 返回现在的日期
+     *
+     * @example NOW()
+     * @namespace 日期函数
+     *
+     * @returns {number} 日期
+     */
     Evaluator.prototype.fnNOW = function () {
         return new Date();
     };
+    /**
+     * 将日期转成日期字符串
+     *
+     * @example DATETOSTR(date[, format="YYYY-MM-DD HH:mm:ss"])
+     * @namespace 日期函数
+     * @param {date} date 日期对象
+     * @param {string} format 日期格式，默认为 "YYYY-MM-DD HH:mm:ss"
+     *
+     * @returns {number} 日期字符串
+     */
     Evaluator.prototype.fnDATETOSTR = function (date, format) {
         if (format === void 0) { format = 'YYYY-MM-DD HH:mm:ss'; }
         return moment__default["default"](date).format(format);
     };
+    /**
+     * 返回日期的指定范围的开端
+     *
+     * @namespace 日期函数
+     * @example STARTOF(date[unit = "day"])
+     * @param {date} date 日期对象
+     * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
+     * @returns {date} 新的日期对象
+     */
     Evaluator.prototype.fnSTARTOF = function (date, unit) {
         return moment__default["default"](date)
             .startOf(unit || 'day')
             .toDate();
     };
+    /**
+     * 返回日期的指定范围的末尾
+     * @namespace 日期函数
+     * @example ENDOF(date[unit = "day"])
+     * @param {date} date 日期对象
+     * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
+     * @returns {date} 新的日期对象
+     */
     Evaluator.prototype.fnENDOF = function (date, unit) {
         return moment__default["default"](date)
             .endOf(unit || 'day')
@@ -662,82 +1085,232 @@ var Evaluator = /** @class */ (function () {
         }
         return raw;
     };
+    /**
+     * 返回日期的年份
+     * @namespace 日期函数
+     * @example YEAR(date)
+     * @param {date} date 日期对象
+     * @returns {number} 数值
+     */
     Evaluator.prototype.fnYEAR = function (date) {
         date = this.normalizeDate(date);
         return date.getFullYear();
     };
+    /**
+     * 返回日期的月份，这里就是自然月份。
+     *
+     * @namespace 日期函数
+     * @example MONTH(date)
+     * @param {date} date 日期对象
+     * @returns {number} 数值
+     */
     Evaluator.prototype.fnMONTH = function (date) {
         date = this.normalizeDate(date);
         return date.getMonth() + 1;
     };
+    /**
+     * 返回日期的天
+     * @namespace 日期函数
+     * @example DAY(date)
+     * @param {date} date 日期对象
+     * @returns {number} 数值
+     */
     Evaluator.prototype.fnDAY = function (date) {
         date = this.normalizeDate(date);
         return date.getDate();
     };
+    /**
+     * 返回日期的小时
+     * @param {date} date 日期对象
+     * @namespace 日期函数
+     * @example HOUR(date)
+     * @returns {number} 数值
+     */
     Evaluator.prototype.fnHOUR = function (date) {
         date = this.normalizeDate(date);
         return date.getHours();
     };
-    Evaluator.prototype.fnHMINUTE = function (date) {
+    /**
+     * 返回日期的分
+     * @param {date} date 日期对象
+     * @namespace 日期函数
+     * @example MINUTE(date)
+     * @returns {number} 数值
+     */
+    Evaluator.prototype.fnMINUTE = function (date) {
         date = this.normalizeDate(date);
         return date.getMinutes();
     };
+    /**
+     * 返回日期的秒
+     * @param {date} date 日期对象
+     * @namespace 日期函数
+     * @example SECOND(date)
+     * @returns {number} 数值
+     */
     Evaluator.prototype.fnSECOND = function (date) {
         date = this.normalizeDate(date);
         return date.getSeconds();
     };
+    /**
+     * 返回两个日期相差多少年
+     * @param {date} endDate 日期对象
+     * @param {date} startDate 日期对象
+     * @namespace 日期函数
+     * @example YEARS(endDate, startDate)
+     * @returns {number} 数值
+     */
     Evaluator.prototype.fnYEARS = function (endDate, startDate) {
         endDate = this.normalizeDate(endDate);
         startDate = this.normalizeDate(startDate);
         return moment__default["default"](endDate).diff(moment__default["default"](startDate), 'year');
     };
+    /**
+     * 返回两个日期相差多少分钟
+     * @param {date} endDate 日期对象
+     * @param {date} startDate 日期对象
+     * @namespace 日期函数
+     * @example MINUTES(endDate, startDate)
+     * @returns {number} 数值
+     */
     Evaluator.prototype.fnMINUTES = function (endDate, startDate) {
         endDate = this.normalizeDate(endDate);
         startDate = this.normalizeDate(startDate);
         return moment__default["default"](endDate).diff(moment__default["default"](startDate), 'minutes');
     };
+    /**
+     * 返回两个日期相差多少天
+     * @param {date} endDate 日期对象
+     * @param {date} startDate 日期对象
+     * @namespace 日期函数
+     * @example DAYS(endDate, startDate)
+     * @returns {number} 数值
+     */
     Evaluator.prototype.fnDAYS = function (endDate, startDate) {
         endDate = this.normalizeDate(endDate);
         startDate = this.normalizeDate(startDate);
         return moment__default["default"](endDate).diff(moment__default["default"](startDate), 'days');
     };
+    /**
+     * 返回两个日期相差多少小时
+     * @param {date} endDate 日期对象
+     * @param {date} startDate 日期对象
+     * @namespace 日期函数
+     * @example HOURS(endDate, startDate)
+     * @returns {number} 数值
+     */
     Evaluator.prototype.fnHOURS = function (endDate, startDate) {
         endDate = this.normalizeDate(endDate);
         startDate = this.normalizeDate(startDate);
         return moment__default["default"](endDate).diff(moment__default["default"](startDate), 'hour');
     };
+    /**
+     * 修改日期，对日期进行加减天、月份、年等操作
+     *
+     * 示例：
+     *
+     * DATEMODIFY(A, -2, 'month')
+     *
+     * 对日期 A 进行往前减2月的操作。
+     *
+     * @param {date} date 日期对象
+     * @param {number} num 数值
+     * @param {string} unit 单位：支持年、月、天等等
+     * @namespace 日期函数
+     * @example DATEMODIFY(date, 2, 'days')
+     * @returns {date} 日期对象
+     */
     Evaluator.prototype.fnDATEMODIFY = function (date, num, format) {
         date = this.normalizeDate(date);
         return moment__default["default"](date).add(num, format).toDate();
     };
+    /**
+     * 将字符日期转成日期对象，可以指定日期格式。
+     *
+     * 示例：STRTODATE('2021/12/6', 'YYYY/MM/DD')
+     *
+     * @param {string} value 日期字符
+     * @param {string} format 日期格式
+     * @namespace 日期函数
+     * @example STRTODATE(value[, format=""])
+     * @returns {date} 日期对象
+     */
     Evaluator.prototype.fnSTRTODATE = function (value, format) {
         if (format === void 0) { format = ''; }
         return moment__default["default"](value, format).toDate();
     };
+    /**
+     * 判断两个日期，是否第一个日期在第二个日期的前面
+     *
+     * @param {date} a 第一个日期
+     * @param {date} b 第二个日期
+     * @param {string} unit 单位，默认是 'day'， 即之比较到天
+     * @namespace 日期函数
+     * @example ISBEFORE(a, b)
+     * @returns {boolean} 判断结果
+     */
     Evaluator.prototype.fnISBEFORE = function (a, b, unit) {
         if (unit === void 0) { unit = 'day'; }
         a = this.normalizeDate(a);
         b = this.normalizeDate(b);
         return moment__default["default"](a).isBefore(moment__default["default"](b), unit);
     };
+    /**
+     * 判断两个日期，是否第一个日期在第二个日期的后面
+     *
+     * @param {date} a 第一个日期
+     * @param {date} b 第二个日期
+     * @param {string} unit 单位，默认是 'day'， 即之比较到天
+     * @namespace 日期函数
+     * @example ISAFTER(a, b)
+     * @returns {boolean} 判断结果
+     */
     Evaluator.prototype.fnISAFTER = function (a, b, unit) {
         if (unit === void 0) { unit = 'day'; }
         a = this.normalizeDate(a);
         b = this.normalizeDate(b);
         return moment__default["default"](a).isAfter(moment__default["default"](b), unit);
     };
+    /**
+     * 判断两个日期，是否第一个日期在第二个日期的前面或者相等
+     *
+     * @param {date} a 第一个日期
+     * @param {date} b 第二个日期
+     * @param {string} unit 单位，默认是 'day'， 即之比较到天
+     * @namespace 日期函数
+     * @example ISSAMEORBEFORE(a, b)
+     * @returns {boolean} 判断结果
+     */
     Evaluator.prototype.fnISSAMEORBEFORE = function (a, b, unit) {
         if (unit === void 0) { unit = 'day'; }
         a = this.normalizeDate(a);
         b = this.normalizeDate(b);
         return moment__default["default"](a).isSameOrBefore(moment__default["default"](b), unit);
     };
+    /**
+     * 判断两个日期，是否第一个日期在第二个日期的后面或者相等
+     *
+     * @param {date} a 第一个日期
+     * @param {date} b 第二个日期
+     * @param {string} unit 单位，默认是 'day'， 即之比较到天
+     * @namespace 日期函数
+     * @example ISSAMEORAFTER(a, b)
+     * @returns {boolean} 判断结果
+     */
     Evaluator.prototype.fnISSAMEORAFTER = function (a, b, unit) {
         if (unit === void 0) { unit = 'day'; }
         a = this.normalizeDate(a);
         b = this.normalizeDate(b);
         return moment__default["default"](a).isSameOrAfter(moment__default["default"](b), unit);
     };
+    /**
+     * 返回数组的长度
+     *
+     * @param {Array<any>} arr 数组
+     * @namespace 其他
+     * @example COUNT(arr)
+     * @returns {boolean} 结果
+     */
     Evaluator.prototype.fnCOUNT = function (value) {
         return Array.isArray(value) ? value.length : value ? 1 : 0;
     };
@@ -999,17 +1572,17 @@ function lexer(input, options) {
                     else {
                         // 支持旧的 $varName 的取值方法
                         var j = i + 2;
-                        while (/^[a-zA-Z0-9_.][a-zA-Z0-9_.\[\]]*$/.test(input.substring(i + 1, j)) &&
+                        while (/^[a-zA-Z0-9_][a-zA-Z0-9_]*$/.test(input.substring(i + 1, j)) &&
                             j <= input.length) {
                             j++;
                         }
                         if (j - i > 2) {
                             tokenCache.push({
                                 type: TokenName[TokenEnum.Variable],
-                                value: input.substring(i + 1, j),
-                                raw: input.substring(i, j),
+                                value: input.substring(i + 1, j - 1),
+                                raw: input.substring(i, j - 1),
                                 start: position(input.substring(index, i)),
-                                end: position(input.substring(index, j))
+                                end: position(input.substring(index, j - 1))
                             });
                             break;
                         }
@@ -1788,10 +2361,7 @@ function parse(input, options) {
         while (matchPunctuator('[') || matchPunctuator('.')) {
             var isDot = matchPunctuator('.');
             next();
-            var right = assert((isDot
-                ? identifier() || numberLiteral()
-                : varibleKey(true)) /* 为了兼容久的语法，理论上来说只需要 identifier, 下面的 rawScript 是不应该有的 */ ||
-                rawScript());
+            var right = assert(isDot ? identifier() || numberLiteral() || rawScript() : expression());
             if (!isDot) {
                 assert(matchPunctuator(']'));
                 next();
@@ -2593,7 +3163,12 @@ var filters = {
         length = parseInt(length, 10) || 200;
         return input.substring(0, length) + (input.length > length ? end : '');
     },
-    url_encode: function (input) { return encodeURIComponent(input); },
+    url_encode: function (input) {
+        if (input == null) {
+            return '';
+        }
+        return encodeURIComponent(input);
+    },
     url_decode: function (input) { return decodeURIComponent(input); },
     default: function (input, defaultValue, strict) {
         var _a;
@@ -2907,6 +3482,7 @@ function skipRestTest(restFilters) {
 }
 function registerFilter(name, fn) {
     filters[name] = fn;
+    Evaluator.setDefaultFilters(filters);
 }
 function getFilters() {
     return filters;