amis-formula 3.1.0 → 3.2.0

package/esm/evalutor.d.ts

@@ -181,14 +181,12 @@ export declare class Evaluator {
         return: any;
     }, args: Array<any>): any;
     /**
-     * 示例：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 逻辑函数
@@ -197,32 +195,32 @@ export declare class Evaluator {
      */
     fnIF(condition: () => any, trueValue: () => any, falseValue: () => any): any;
     /**
-     * 条件全部符合，返回 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}
      */
     fnAND(...condtions: Array<() => any>): boolean;
     /**
-     * 条件任意一个满足条件，返回 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}
@@ -231,9 +229,12 @@ export declare class Evaluator {
     /**
      * 异或处理，多个表达式组中存在奇数个真时认为真。
      *
-     * @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}
@@ -242,18 +243,19 @@ export declare class Evaluator {
     /**
      * 判断函数集合，相当于多个 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。
      */
     fnIFS(...args: Array<() => any>): any;
     /**
-     * 返回传入数字的绝对值
+     * 返回传入数字的绝对值。
      *
      * @example ABS(num)
      * @param {number} num - 数值
@@ -263,7 +265,7 @@ export declare class Evaluator {
      */
     fnABS(a: number): number;
     /**
-     * 获取最大值，如果只有一个参数且是数组，则计算这个数组内的值
+     * 获取最大值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example MAX(num1, num2, ...numN)
      * @param {...number} num - 数值
@@ -273,7 +275,7 @@ export declare class Evaluator {
      */
     fnMAX(...args: Array<any>): any;
     /**
-     * 获取最小值，如果只有一个参数且是数组，则计算这个数组内的值
+     * 获取最小值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example MIN(num1, num2, ...numN)
      * @param {...number} num - 数值
@@ -283,7 +285,7 @@ export declare class Evaluator {
      */
     fnMIN(...args: Array<number>): any;
     /**
-     * 求和，如果只有一个参数且是数组，则计算这个数组内的值
+     * 求和，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example SUM(num1, num2, ...numN)
      * @param {...number} num - 数值
@@ -293,7 +295,7 @@ export declare class Evaluator {
      */
     fnSUM(...args: Array<number>): any;
     /**
-     * 将数值向下取整为最接近的整数
+     * 将数值向下取整为最接近的整数。
      *
      * @example INT(num)
      * @param {number} num - 数值
@@ -303,7 +305,7 @@ export declare class Evaluator {
      */
     fnINT(n: number): number;
     /**
-     * 返回两数相除的余数，参数 number 是被除数，divisor 是除数
+     * 返回两数相除的余数，参数 number 是被除数，divisor 是除数。
      *
      * @example MOD(num, divisor)
      * @param {number} num - 被除数
@@ -314,7 +316,7 @@ export declare class Evaluator {
      */
     fnMOD(a: number, b: number): number;
     /**
-     * 圆周率 3.1415...
+     * 圆周率 3.1415...。
      *
      * @example PI()
      * @namespace 数学函数
@@ -327,7 +329,7 @@ export declare class Evaluator {
      *
      * @example ROUND(num[, numDigits = 2])
      * @param {number} num - 要处理的数字
-     * @param {number} numDigits - 小数位数
+     * @param {number} numDigits - 小数位数，默认为2
      * @namespace 数学函数
      *
      * @returns {number} 传入数值四舍五入后的结果
@@ -338,7 +340,7 @@ export declare class Evaluator {
      *
      * @example FLOOR(num[, numDigits=2])
      * @param {number} num - 要处理的数字
-     * @param {number} numDigits - 小数位数
+     * @param {number} numDigits - 小数位数，默认为2
      * @namespace 数学函数
      *
      * @returns {number} 传入数值向下取整后的结果
@@ -349,7 +351,7 @@ export declare class Evaluator {
      *
      * @example CEIL(num[, numDigits=2])
      * @param {number} num - 要处理的数字
-     * @param {number} numDigits - 小数位数
+     * @param {number} numDigits - 小数位数，默认为2
      * @namespace 数学函数
      *
      * @returns {number} 传入数值向上取整后的结果
@@ -366,7 +368,7 @@ export declare class Evaluator {
      */
     fnSQRT(n: number): number;
     /**
-     * 返回所有参数的平均值，如果只有一个参数且是数组，则计算这个数组内的值
+     * 返回所有参数的平均值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example AVG(num1, num2, ...numN)
      * @param {...number} num - 要处理的数字
@@ -376,7 +378,7 @@ export declare class Evaluator {
      */
     fnAVG(...args: Array<any>): number;
     /**
-     * 返回数据点与数据均值点之差（数据偏差）的平方和，如果只有一个参数且是数组，则计算这个数组内的值
+     * 返回数据点与数据均值点之差（数据偏差）的平方和，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example DEVSQ(num1, num2, ...numN)
      * @param {...number} num - 要处理的数字
@@ -386,7 +388,7 @@ export declare class Evaluator {
      */
     fnDEVSQ(...args: Array<any>): number | null;
     /**
-     * 数据点到其算术平均值的绝对偏差的平均值
+     * 数据点到其算术平均值的绝对偏差的平均值。
      *
      * @example AVEDEV(num1, num2, ...numN)
      * @param {...number} num - 要处理的数字
@@ -396,7 +398,7 @@ export declare class Evaluator {
      */
     fnAVEDEV(...args: Array<any>): number | null;
     /**
-     * 数据点的调和平均值，如果只有一个参数且是数组，则计算这个数组内的值
+     * 数据点的调和平均值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
      * @example HARMEAN(num1, num2, ...numN)
      * @param {...number} num - 要处理的数字
@@ -406,7 +408,7 @@ export declare class Evaluator {
      */
     fnHARMEAN(...args: Array<any>): number | null;
     /**
-     * 数据集中第 k 个最大值
+     * 数据集中第 k 个最大值。
      *
      * @example LARGE(array, k)
      * @param {array} nums - 要处理的数字
@@ -417,7 +419,7 @@ export declare class Evaluator {
      */
     fnLARGE(nums: Array<any>, k: number): any;
     /**
-     * 将数值转为中文大写金额
+     * 将数值转为中文大写金额。
      *
      * @example UPPERMONEY(num)
      * @param {number} num - 要处理的数字
@@ -429,9 +431,9 @@ export declare class Evaluator {
     /**
      * 返回大于等于 0 且小于 1 的均匀分布随机实数。每一次触发计算都会变化。
      *
-     * 示例：`RAND()*100`
+     * 示例：`RAND()*100`，
      *
-     * 返回 0-100 之间的随机数
+     * 返回 0-100 之间的随机数。
      *
      * @example RAND()
      * @namespace 数学函数
@@ -440,7 +442,7 @@ export declare class Evaluator {
      */
     fnRAND(): number;
     /**
-     * 取数据最后一个
+     * 取数据最后一个。
      *
      * @example LAST(array)
      * @param {...number} arr - 要处理的数组
@@ -473,7 +475,7 @@ export declare class Evaluator {
      */
     fnRIGHT(text: string, len: number): string;
     /**
-     * 计算文本的长度
+     * 计算文本的长度。
      *
      * @example LEN(text)
      * @param {string} text - 要处理的文本
@@ -483,7 +485,7 @@ export declare class Evaluator {
      */
     fnLEN(text: string): number;
     /**
-     * 计算文本集合中所有文本的长度
+     * 计算文本集合中所有文本的长度。
      *
      * @example LENGTH(textArr)
      * @param {string[]} textArr - 要处理的文本集合
@@ -493,7 +495,7 @@ export declare class Evaluator {
      */
     fnLENGTH(...args: any[]): any;
     /**
-     * 判断文本是否为空
+     * 判断文本是否为空。
      *
      * @example ISEMPTY(text)
      * @param {string} text - 要处理的文本
@@ -503,7 +505,7 @@ export declare class Evaluator {
      */
     fnISEMPTY(text: string): boolean;
     /**
-     * 将多个传入值连接成文本
+     * 将多个传入值连接成文本。
      *
      * @example CONCATENATE(text1, text2, ...textN)
      * @param {...string} text - 文本集合
@@ -515,7 +517,7 @@ export declare class Evaluator {
     /**
      * 返回计算机字符集的数字代码所对应的字符。
      *
-     * `CHAR(97)` 等价于 "a"
+     * 示例：`CHAR(97)` 等价于 "a"。
      *
      * @example CHAR(code)
      * @param {number} code - 编码值
@@ -525,7 +527,7 @@ export declare class Evaluator {
      */
     fnCHAR(code: number): string;
     /**
-     * 将传入文本转成小写
+     * 将传入文本转成小写。
      *
      * @example LOWER(text)
      * @param {string} text - 文本
@@ -535,7 +537,7 @@ export declare class Evaluator {
      */
     fnLOWER(text: string): string;
     /**
-     * 将传入文本转成大写
+     * 将传入文本转成大写。
      *
      * @example UPPER(text)
      * @param {string} text - 文本
@@ -545,7 +547,7 @@ export declare class Evaluator {
      */
     fnUPPER(text: string): string;
     /**
-     * 将传入文本首字母转成大写
+     * 将传入文本首字母转成大写。
      *
      * @example UPPERFIRST(text)
      * @param {string} text - 文本
@@ -555,11 +557,11 @@ export declare class Evaluator {
      */
     fnUPPERFIRST(text: string): string;
     /**
-     * 向前补齐文本长度
+     * 向前补齐文本长度。
      *
-     * 示例 `PADSTART("6", 2, "0")`
+     * 示例 `PADSTART("6", 2, "0")`，
      *
-     * 返回 `06`
+     * 返回 `06`。
      *
      * @example PADSTART(text)
      * @param {string} text - 文本
@@ -571,11 +573,11 @@ export declare class Evaluator {
      */
     fnPADSTART(text: string, num: number, pad: string): string;
     /**
-     * 将文本转成标题
+     * 将文本转成标题。
      *
-     * 示例 `CAPITALIZE("star")`
+     * 示例 `CAPITALIZE("star")`，
      *
-     * 返回 `Star`
+     * 返回 `Star`。
      *
      * @example CAPITALIZE(text)
      * @param {string} text - 文本
@@ -585,11 +587,11 @@ export declare class Evaluator {
      */
     fnCAPITALIZE(text: string): string;
     /**
-     * 对文本进行 HTML 转义
+     * 对文本进行 HTML 转义。
      *
-     * 示例 `ESCAPE("<star>&")`
+     * 示例 `ESCAPE("<star>&")`，
      *
-     * 返回 `&lt;start&gt;&amp;`
+     * 返回 `&lt;start&gt;&amp;`。
      *
      * @example ESCAPE(text)
      * @param {string} text - 文本
@@ -599,11 +601,11 @@ export declare class Evaluator {
      */
     fnESCAPE(text: string): string;
     /**
-     * 对文本长度进行截断
+     * 对文本长度进行截断。
      *
-     * 示例 `TRUNCATE("amis.baidu.com", 6)`
+     * 示例 `TRUNCATE("amis.baidu.com", 6)`，
      *
-     * 返回 `amis...`
+     * 返回 `amis...`。
      *
      * @example TRUNCATE(text, 6)
      * @param {string} text - 文本
@@ -614,7 +616,7 @@ export declare class Evaluator {
      */
     fnTRUNCATE(text: string, length: number): string;
     /**
-     *  取在某个分隔符之前的所有字符串
+     *  取在某个分隔符之前的所有字符串。
      *
      * @example  BEFORELAST(text, '.')
      * @param {string} text - 文本
@@ -625,11 +627,11 @@ export declare class Evaluator {
      */
     fnBEFORELAST(text: string, delimiter?: string): string;
     /**
-     * 将文本根据指定片段分割成数组
+     * 将文本根据指定片段分割成数组。
      *
-     * 示例：`SPLIT("a,b,c", ",")`
+     * 示例：`SPLIT("a,b,c", ",")`，
      *
-     * 返回 `["a", "b", "c"]`
+     * 返回 `["a", "b", "c"]`。
      *
      * @example SPLIT(text, ',')
      * @param {string} text - 文本
@@ -640,7 +642,7 @@ export declare class Evaluator {
      */
     fnSPLIT(text: string, sep?: string): string[];
     /**
-     * 将文本去除前后空格
+     * 将文本去除前后空格。
      *
      * @example TRIM(text)
      * @param {string} text - 文本
@@ -650,11 +652,11 @@ export declare class Evaluator {
      */
     fnTRIM(text: string): string;
     /**
-     * 去除文本中的 HTML 标签
+     * 去除文本中的 HTML 标签。
      *
-     * 示例：`STRIPTAG("<b>amis</b>")`
+     * 示例：`STRIPTAG("<b>amis</b>")`，
      *
-     * 返回：`amis`
+     * 返回：`amis`。
      *
      * @example STRIPTAG(text)
      * @param {string} text - 文本
@@ -664,11 +666,11 @@ export declare class Evaluator {
      */
     fnSTRIPTAG(text: string): string;
     /**
-     * 将字符串中的换行转成 HTML `<br>`，用于简单换行的场景
+     * 将字符串中的换行转成 HTML `<br>`，用于简单换行的场景。
      *
-     * 示例：`LINEBREAK("\n")`
+     * 示例：`LINEBREAK("\n")`，
      *
-     * 返回：`<br/>`
+     * 返回：`<br/>`。
      *
      * @example LINEBREAK(text)
      * @param {string} text - 文本
@@ -678,7 +680,7 @@ export declare class Evaluator {
      */
     fnLINEBREAK(text: string): string;
     /**
-     * 判断字符串(text)是否以特定字符串(startString)开始，是则返回 True，否则返回 False
+     * 判断字符串(text)是否以特定字符串(startString)开始，是则返回 true，否则返回 false。
      *
      * @example STARTSWITH(text, '片段')
      * @param {string} text - 文本
@@ -689,7 +691,7 @@ export declare class Evaluator {
      */
     fnSTARTSWITH(text: string, search: string): boolean;
     /**
-     * 判断字符串(text)是否以特定字符串(endString)结束，是则返回 True，否则返回 False
+     * 判断字符串(text)是否以特定字符串(endString)结束，是则返回 true，否则返回 false。
      *
      * @example ENDSWITH(text, '片段')
      * @param {string} text - 文本
@@ -700,7 +702,7 @@ export declare class Evaluator {
      */
     fnENDSWITH(text: string, search: string): boolean;
     /**
-     * 判断参数 1 中的文本是否包含参数 2 中的文本。
+     * 判断参数 1 中的文本是否包含参数 2 中的文本，是则返回 true，否则返回 false。
      *
      * @example CONTAINS(text, searchText)
      * @param {string} text - 文本
@@ -723,7 +725,7 @@ export declare class Evaluator {
      */
     fnREPLACE(text: string, search: string, replace: string): string;
     /**
-     * 对文本进行搜索，返回命中的位置
+     * 对文本进行搜索，返回命中的位置。
      *
      * @example SEARCH(text, search, 0)
      * @param {string} text - 要处理的文本
@@ -735,7 +737,7 @@ export declare class Evaluator {
      */
     fnSEARCH(text: string, search: string, start?: number): number;
     /**
-     * 返回文本字符串中从指定位置开始的特定数目的字符
+     * 返回文本字符串中从指定位置开始的特定数目的字符。
      *
      * @example MID(text, from, len)
      * @param {string} text - 要处理的文本
@@ -747,11 +749,11 @@ export declare class Evaluator {
      */
     fnMID(text: string, from: number, len: number): string;
     /**
-     * 返回路径中的文件名
+     * 返回路径中的文件名。
      *
-     * 示例：`/home/amis/a.json`
+     * 示例：`/home/amis/a.json`，
      *
-     * 返回：a.json`
+     * 返回：a.json`。
      *
      * @example BASENAME(text)
      * @param {string} text - 要处理的文本
@@ -763,8 +765,8 @@ export declare class Evaluator {
     /**
      * 创建日期对象，可以通过特定格式的字符串，或者数值。
      *
-     * 需要注意的是，其中月份的数值是从0开始的，也就是说，
-     * 如果是12月份，你应该传入数值11。
+     * 需要注意的是，其中月份的数值是从0开始的，
+     * 即如果是12月份，你应该传入数值11。
      *
      * @example DATE(2021, 11, 6, 8, 20, 0)
      * @example DATE('2021-12-06 08:20:00')
@@ -774,10 +776,9 @@ export declare class Evaluator {
      */
     fnDATE(year: number, month: number, day: number, hour: number, minute: number, second: number): Date;
     /**
-     * 返回时间的时间戳
+     * 返回时间的时间戳。
      *
      * @example TIMESTAMP(date[, format = "X"])
-     * @example TIMESTAMP(date, 'x')
      * @namespace 日期函数
      * @param {date} date 日期对象
      * @param {string} format 时间戳格式，带毫秒传入 'x'。默认为 'X' 不带毫秒的。
@@ -786,7 +787,7 @@ export declare class Evaluator {
      */
     fnTIMESTAMP(date: Date, format?: 'x' | 'X'): number;
     /**
-     * 返回今天的日期
+     * 返回今天的日期。
      *
      * @example TODAY()
      * @namespace 日期函数
@@ -804,11 +805,11 @@ export declare class Evaluator {
      */
     fnNOW(): Date;
     /**
-     * 获取日期的星期几，
+     * 获取日期的星期几。
      *
-     * 示例：
+     * 示例
      *
-     * WEEKDAY('2023-02-27') 得到 1
+     * WEEKDAY('2023-02-27') 得到 1。
      *
      * @example WEEKDAY(date)
      * @namespace 日期函数
@@ -819,11 +820,11 @@ export declare class Evaluator {
      */
     fnWEEKDAY(date: Date | string | number, type?: number): number;
     /**
-     * 获取年份的星期，即第几周
+     * 获取年份的星期，即第几周。
      *
-     * 示例：
+     * 示例
      *
-     * WEEK('2023-03-05') 得到 10
+     * WEEK('2023-03-05') 得到 10。
      *
      * @example WEEK(date)
      * @namespace 日期函数
@@ -834,14 +835,14 @@ export declare class Evaluator {
      */
     fnWEEK(date: Date | string | number, isISO?: boolean): number;
     /**
-     * 对日期、日期字符串、时间戳进行格式化
+     * 对日期、日期字符串、时间戳进行格式化。
      *
-     * 示例：
+     * 示例
      *
-     * 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 日期函数
@@ -852,16 +853,16 @@ export declare class Evaluator {
      */
     fnDATETOSTR(date: Date | string | number, format?: string): string;
     /**
-     * 获取日期范围字符串中的开始时间、结束时间
+     * 获取日期范围字符串中的开始时间、结束时间。
      *
      * 示例：
      *
-     * 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 日期函数
@@ -874,7 +875,7 @@ export declare class Evaluator {
      */
     fnDATERANGESPLIT(daterange: string, key?: string, format?: string, delimiter?: string): string | string[];
     /**
-     * 返回日期的指定范围的开端
+     * 返回日期的指定范围的开端。
      *
      * @namespace 日期函数
      * @example STARTOF(date[unit = "day"])
@@ -885,7 +886,8 @@ export declare class Evaluator {
      */
     fnSTARTOF(date: Date, unit?: any, format?: string): string | Date;
     /**
-     * 返回日期的指定范围的末尾
+     * 返回日期的指定范围的末尾。
+     *
      * @namespace 日期函数
      * @example ENDOF(date[unit = "day"])
      * @param {date} date 日期对象
@@ -897,7 +899,8 @@ export declare class Evaluator {
     normalizeDate(raw: any): Date;
     normalizeDateRange(raw: string | Date[]): Date[];
     /**
-     * 返回日期的年份
+     * 返回日期的年份。
+     *
      * @namespace 日期函数
      * @example YEAR(date)
      * @param {date} date 日期对象
@@ -914,7 +917,8 @@ export declare class Evaluator {
      */
     fnMONTH(date: Date): number;
     /**
-     * 返回日期的天
+     * 返回日期的天。
+     *
      * @namespace 日期函数
      * @example DAY(date)
      * @param {date} date 日期对象
@@ -922,7 +926,8 @@ export declare class Evaluator {
      */
     fnDAY(date: Date): number;
     /**
-     * 返回日期的小时
+     * 返回日期的小时。
+     *
      * @param {date} date 日期对象
      * @namespace 日期函数
      * @example HOUR(date)
@@ -930,7 +935,8 @@ export declare class Evaluator {
      */
     fnHOUR(date: Date): number;
     /**
-     * 返回日期的分
+     * 返回日期的分。
+     *
      * @param {date} date 日期对象
      * @namespace 日期函数
      * @example MINUTE(date)
@@ -938,7 +944,8 @@ export declare class Evaluator {
      */
     fnMINUTE(date: Date): number;
     /**
-     * 返回日期的秒
+     * 返回日期的秒。
+     *
      * @param {date} date 日期对象
      * @namespace 日期函数
      * @example SECOND(date)
@@ -946,7 +953,8 @@ export declare class Evaluator {
      */
     fnSECOND(date: Date): number;
     /**
-     * 返回两个日期相差多少年
+     * 返回两个日期相差多少年。
+     *
      * @param {date} endDate 日期对象
      * @param {date} startDate 日期对象
      * @namespace 日期函数
@@ -955,7 +963,8 @@ export declare class Evaluator {
      */
     fnYEARS(endDate: Date, startDate: Date): number;
     /**
-     * 返回两个日期相差多少分钟
+     * 返回两个日期相差多少分钟。
+     *
      * @param {date} endDate 日期对象
      * @param {date} startDate 日期对象
      * @namespace 日期函数
@@ -964,7 +973,8 @@ export declare class Evaluator {
      */
     fnMINUTES(endDate: Date, startDate: Date): number;
     /**
-     * 返回两个日期相差多少天
+     * 返回两个日期相差多少天。
+     *
      * @param {date} endDate 日期对象
      * @param {date} startDate 日期对象
      * @namespace 日期函数
@@ -973,7 +983,8 @@ export declare class Evaluator {
      */
     fnDAYS(endDate: Date, startDate: Date): number;
     /**
-     * 返回两个日期相差多少小时
+     * 返回两个日期相差多少小时。
+     *
      * @param {date} endDate 日期对象
      * @param {date} startDate 日期对象
      * @namespace 日期函数
@@ -982,11 +993,11 @@ export declare class Evaluator {
      */
     fnHOURS(endDate: Date, startDate: Date): number;
     /**
-     * 修改日期，对日期进行加减天、月份、年等操作
+     * 修改日期，对日期进行加减天、月份、年等操作。
      *
      * 示例：
      *
-     * DATEMODIFY(A, -2, 'month')
+     * DATEMODIFY(A, -2, 'month')，
      *
      * 对日期 A 进行往前减2月的操作。
      *
@@ -1011,7 +1022,7 @@ export declare class Evaluator {
      */
     fnSTRTODATE(value: any, format?: string): Date;
     /**
-     * 判断两个日期，是否第一个日期在第二个日期的前面
+     * 判断两个日期，是否第一个日期在第二个日期的前面，是则返回 true，否则返回 false。
      *
      * @param {date} a 第一个日期
      * @param {date} b 第二个日期
@@ -1022,7 +1033,7 @@ export declare class Evaluator {
      */
     fnISBEFORE(a: Date, b: Date, unit?: any): boolean;
     /**
-     * 判断两个日期，是否第一个日期在第二个日期的后面
+     * 判断两个日期，是否第一个日期在第二个日期的后面，是则返回 true，否则返回 false。
      *
      * @param {date} a 第一个日期
      * @param {date} b 第二个日期
@@ -1033,9 +1044,9 @@ export declare class Evaluator {
      */
     fnISAFTER(a: Date, b: Date, unit?: any): boolean;
     /**
-     * 判断日期是否在指定范围内
+     * 判断日期是否在指定范围内，是则返回 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 日期范围
@@ -1047,7 +1058,7 @@ export declare class Evaluator {
      */
     fnBETWEENRANGE(date: Date, daterange: Date[], unit?: any, inclusivity?: '[]' | '()' | '(]' | '[)'): boolean;
     /**
-     * 判断两个日期，是否第一个日期在第二个日期的前面或者相等
+     * 判断两个日期，是否第一个日期在第二个日期的前面或者相等，是则返回 true，否则返回 false。
      *
      * @param {date} a 第一个日期
      * @param {date} b 第二个日期
@@ -1058,7 +1069,7 @@ export declare class Evaluator {
      */
     fnISSAMEORBEFORE(a: Date, b: Date, unit?: any): boolean;
     /**
-     * 判断两个日期，是否第一个日期在第二个日期的后面或者相等
+     * 判断两个日期，是否第一个日期在第二个日期的后面或者相等，是则返回 true，否则返回 false。
      *
      * @param {date} a 第一个日期
      * @param {date} b 第二个日期
@@ -1069,7 +1080,7 @@ export declare class Evaluator {
      */
     fnISSAMEORAFTER(a: Date, b: Date, unit?: any): boolean;
     /**
-     * 返回数组的长度
+     * 返回数组的长度。
      *
      * @param {Array<any>} arr 数组
      * @namespace 数组
@@ -1104,7 +1115,7 @@ export declare class Evaluator {
      *
      * 示例：
      *
-     * ARRAYFINDINDEX([0, 2, false], item => item === 2) 得到 1
+     * ARRAYFINDINDEX([0, 2, false], item => item === 2) 得到 1。
      *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
@@ -1119,7 +1130,7 @@ export declare class Evaluator {
      *
      * 示例：
      *
-     * ARRAYFIND([0, 2, false], item => item === 2) 得到 2
+     * ARRAYFIND([0, 2, false], item => item === 2) 得到 2。
      *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
@@ -1130,11 +1141,11 @@ export declare class Evaluator {
     fnARRAYFIND(arr: any[], iterator: any): any;
     /**
      * 数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
-     * 判断第二个箭头函数是否存在返回为 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 箭头函数
@@ -1145,7 +1156,7 @@ export declare class Evaluator {
     fnARRAYSOME(arr: any[], iterator: any): boolean;
     /**
      * 数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
-     * 判断第二个箭头函数返回是否都为 true。
+     * 判断第二个箭头函数返回是否都为 true，是则返回 true，否则返回 false。
      *
      * 示例：
      *
@@ -1159,11 +1170,11 @@ export declare class Evaluator {
      */
     fnARRAYEVERY(arr: any[], iterator: any): boolean;
     /**
-     * 判断数据中是否存在指定元素
+     * 判断数据中是否存在指定元素。
      *
      * 示例：
      *
-     * ARRAYINCLUDES([0, 2, false], 2) 得到 true
+     * ARRAYINCLUDES([0, 2, false], 2) 得到 true。
      *
      * @param {Array<any>} arr 数组
      * @param {any} item 元素
@@ -1173,11 +1184,11 @@ export declare class Evaluator {
      */
     fnARRAYINCLUDES(arr: any[], item: any): boolean;
     /**
-     * 数组过滤掉 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 数组
@@ -1186,11 +1197,11 @@ export declare class Evaluator {
      */
     fnCOMPACT(arr: any[]): any[];
     /**
-     * 数组转成字符串
+     * 数组转成字符串。
      *
      * 示例：
      *
-     * JOIN(['a', 'b', 'c'], '=') 得到 'a=b=c'
+     * JOIN(['a', 'b', 'c'], '=') 得到 'a=b=c'。
      *
      * @param {Array<any>} arr 数组
      * @param { String} separator 分隔符
@@ -1200,11 +1211,11 @@ export declare class Evaluator {
      */
     fnJOIN(arr: any[], separator?: string): string;
     /**
-     * 数组合并
+     * 数组合并。
      *
      * 示例：
      *
-     * 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 数组
@@ -1213,11 +1224,11 @@ export declare class Evaluator {
      */
     fnCONCAT(...arr: any[]): any;
     /**
-     * 数组去重，第二个参数「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 字段
@@ -1228,11 +1239,11 @@ export declare class Evaluator {
      */
     fnUNIQ(arr: any[], field?: string): any[];
     /**
-     * 将JS对象转换成JSON字符串
+     * 将JS对象转换成JSON字符串。
      *
      * 示例：
      *
-     * ENCODEJSON({name: 'amis'}) 得到 '{"name":"amis"}'
+     * ENCODEJSON({name: 'amis'}) 得到 '{"name":"amis"}'。
      *
      * @param {object} obj JS对象
      * @namespace 编码
@@ -1241,11 +1252,11 @@ export declare class Evaluator {
      */
     fnENCODEJSON(obj: object): string;
     /**
-     * 解析JSON编码数据，返回JS对象
+     * 解析JSON编码数据，返回JS对象。
      *
      * 示例：
      *
-     * DECODEJSON('{\"name\": "amis"}') 得到 {name: 'amis'}
+     * DECODEJSON('{\"name\": "amis"}') 得到 {name: 'amis'}。
      *
      * @param {string} str 字符串
      * @namespace 编码
@@ -1254,15 +1265,15 @@ export declare class Evaluator {
      */
     fnDECODEJSON(str: string): object;
     /**
-     * 根据对象或者数组的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 路径