amis-formula 1.2.3 → 1.2.7

package/dist/evalutor.d.ts

@@ -196,65 +196,640 @@ export declare class Evaluator {
         identifier: string;
         args: Array<any>;
     }): any;
+    /**
+     * 示例：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} 根据条件返回不同的结果
+     */
     fnIF(condition: () => any, trueValue: () => any, falseValue: () => any): any;
+    /**
+     * 条件全部符合，返回 true，否则返回 false
+     *
+     * 示例：AND(语文成绩>80, 数学成绩>80)
+     *
+     * 语文成绩和数学成绩都大于 80，则返回 true，否则返回 false
+     *
+     * 也可以直接用表达式如：语文成绩>80 && 数学成绩>80
+     *
+     * @example AND(expression1, expression2, ...expressionN)
+     * @param {...expression} conditions - 条件表达式.
+     * @namespace 逻辑函数
+     *
+     * @returns {boolean}
+     */
     fnAND(...condtions: Array<() => any>): boolean;
+    /**
+     * 条件任意一个满足条件，返回 true，否则返回 false
+     *
+     * 示例：OR(语文成绩>80, 数学成绩>80)
+     *
+     * 语文成绩和数学成绩任意一个大于 80，则返回 true，否则返回 false
+     *
+     * 也可以直接用表达式如：语文成绩>80 || 数学成绩>80
+     *
+     * @example OR(expression1, expression2, ...expressionN)
+     * @param {...expression} conditions - 条件表达式.
+     * @namespace 逻辑函数
+     *
+     * @returns {boolean}
+     */
     fnOR(...condtions: Array<() => any>): boolean;
+    /**
+     * 异或处理，两个表达式同时为「真」，或者同时为「假」，则结果返回为「真」
+     *
+     * @example XOR(condition1, condition2)
+     * @param {expression} condition1 - 条件表达式1
+     * @param {expression} condition2 - 条件表达式2
+     * @namespace 逻辑函数
+     *
+     * @returns {boolean}
+     */
     fnXOR(c1: () => any, c2: () => any): boolean;
+    /**
+     * 判断函数集合，相当于多个 else if 合并成一个。
+     *
+     * 示例：IFS(语文成绩 > 80, "优秀", 语文成绩 > 60, "良", "继续努力")
+     *
+     * 如果语文成绩大于 80，则返回优秀，否则判断大于 60 分，则返回良，否则返回继续努力。
+     *
+     * @example IFS(condition1, result1, condition2, result2,...conditionN, resultN)
+     * @param {...any} args - 条件，返回值集合
+     * @namespace 逻辑函数
+     * @returns {any} 第一个满足条件的结果，没有命中的返回 false。
+     */
     fnIFS(...args: Array<() => any>): any;
+    /**
+     * 返回传入数字的绝对值
+     *
+     * @example ABS(num)
+     * @param {number} num - 数值
+     * @namespace 数学函数
+     *
+     * @returns {number} 传入数值的绝对值
+     */
     fnABS(a: number): number;
+    /**
+     * 获取最大值
+     *
+     * @example MAX(num1, num2, ...numN)
+     * @param {...number} num - 数值
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有传入值中最大的那个
+     */
     fnMAX(...args: Array<any>): any;
+    /**
+     * 获取最小值
+     *
+     * @example MIN(num1, num2, ...numN)
+     * @param {...number} num - 数值
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有传入值中最小的那个
+     */
     fnMIN(...args: Array<number>): any;
+    /**
+     * 求和
+     *
+     * @example SUM(num1, num2, ...numN)
+     * @param {...number} num - 数值
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有传入数值的总和
+     */
     fnSUM(...args: Array<number>): any;
+    /**
+     * 将数值向下取整为最接近的整数
+     *
+     * @example INT(num)
+     * @param {number} num - 数值
+     * @namespace 数学函数
+     *
+     * @returns {number} 数值对应的整形
+     */
     fnINT(n: number): number;
+    /**
+     * 返回两数相除的余数，参数 number 是被除数，divisor 是除数
+     *
+     * @example MOD(num, divisor)
+     * @param {number} num - 被除数
+     * @param {number} divisor - 除数
+     * @namespace 数学函数
+     *
+     * @returns {number} 两数相除的余数
+     */
     fnMOD(a: number, b: number): number;
+    /**
+     * 圆周率 3.1415...
+     *
+     * @example PI()
+     * @namespace 数学函数
+     *
+     * @returns {number} 圆周率数值
+     */
     fnPI(): number;
+    /**
+     * 将数字四舍五入到指定的位数，可以设置小数位。
+     *
+     * @example ROUND(num[, numDigits = 2])
+     * @param {number} num - 要处理的数字
+     * @param {number} numDigits - 小数位数
+     * @namespace 数学函数
+     *
+     * @returns {number} 传入数值四舍五入后的结果
+     */
     fnROUND(a: number, b: number): number;
+    /**
+     * 将数字向下取整到指定的位数，可以设置小数位。
+     *
+     * @example FLOOR(num[, numDigits=2])
+     * @param {number} num - 要处理的数字
+     * @param {number} numDigits - 小数位数
+     * @namespace 数学函数
+     *
+     * @returns {number} 传入数值向下取整后的结果
+     */
     fnFLOOR(a: number, b: number): number;
+    /**
+     * 将数字向上取整到指定的位数，可以设置小数位。
+     *
+     * @example CEIL(num[, numDigits=2])
+     * @param {number} num - 要处理的数字
+     * @param {number} numDigits - 小数位数
+     * @namespace 数学函数
+     *
+     * @returns {number} 传入数值向上取整后的结果
+     */
     fnCEIL(a: number, b: number): number;
+    /**
+     * 开平方，参数 number 为非负数
+     *
+     * @example SQRT(num)
+     * @param {number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {number} 开平方的结果
+     */
     fnSQRT(n: number): number;
+    /**
+     * 返回所有参数的平均值
+     *
+     * @example AVG(num1, num2, ...numN)
+     * @param {...number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有数值的平均值
+     */
     fnAVG(...args: Array<any>): number;
+    /**
+     * 将数值转为中文大写金额
+     *
+     * @example UPPERMONEY(num)
+     * @param {number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {string} 数值中文大写字符
+     */
     fnUPPERMONEY(n: number): string;
+    /**
+     * 返回大于等于 0 且小于 1 的均匀分布随机实数。每一次触发计算都会变化。
+     *
+     * 示例：`RAND()*100`
+     *
+     * 返回 0-100 之间的随机数
+     *
+     * @example RAND()
+     * @namespace 数学函数
+     *
+     * @returns {number} 随机数
+     */
     fnRAND(): number;
     normalizeText(raw: any): string;
+    /**
+     * 返回传入文本左侧的指定长度字符串。
+     *
+     * @example LEFT(text, len)
+     * @param {string} text - 要处理的文本
+     * @param {number} len - 要处理的长度
+     * @namespace 文本函数
+     *
+     * @returns {string} 对应字符串
+     */
     fnLEFT(text: string, len: number): string;
+    /**
+     * 返回传入文本右侧的指定长度字符串。
+     *
+     * @example RIGHT(text, len)
+     * @param {string} text - 要处理的文本
+     * @param {number} len - 要处理的长度
+     * @namespace 文本函数
+     *
+     * @returns {string} 对应字符串
+     */
     fnRIGHT(text: string, len: number): string;
+    /**
+     * 计算文本的长度
+     *
+     * @example LEN(text)
+     * @param {string} text - 要处理的文本
+     * @namespace 文本函数
+     *
+     * @returns {number} 长度
+     */
     fnLEN(text: string): number;
+    /**
+     * 计算文本集合中所有文本的长度
+     *
+     * @example LENGTH(textArr)
+     * @param {string[]} textArr - 要处理的文本集合
+     * @namespace 文本函数
+     *
+     * @returns {number[]} 长度集合
+     */
     fnLENGTH(...args: any[]): any;
+    /**
+     * 判断文本是否为空
+     *
+     * @example ISEMPTY(text)
+     * @param {string} text - 要处理的文本
+     * @namespace 文本函数
+     *
+     * @returns {boolean} 判断结果
+     */
     fnISEMPTY(text: string): boolean;
+    /**
+     * 将多个传入值连接成文本
+     *
+     * @example CONCATENATE(text1, text2, ...textN)
+     * @param {...string} text - 文本集合
+     * @namespace 文本函数
+     *
+     * @returns {string} 连接后的文本
+     */
     fnCONCATENATE(...args: Array<any>): string;
+    /**
+     * 返回计算机字符集的数字代码所对应的字符。
+     *
+     * `CHAR(97)` 等价于 "a"
+     *
+     * @example CHAR(code)
+     * @param {number} code - 编码值
+     * @namespace 文本函数
+     *
+     * @returns {string} 指定位置的字符
+     */
     fnCHAR(code: number): string;
+    /**
+     * 将传入文本转成小写
+     *
+     * @example LOWER(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
     fnLOWER(text: string): string;
+    /**
+     * 将传入文本转成大写
+     *
+     * @example UPPER(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
     fnUPPER(text: string): string;
+    /**
+     * 将文本根据指定片段分割成数组
+     *
+     * 示例：`SPLIT("a,b,c", ",")`
+     *
+     * 返回 `["a", "b", "c"]`
+     *
+     * @example SPLIT(text, ',')
+     * @param {string} text - 文本
+     * @param {string} delimiter - 文本片段
+     * @namespace 文本函数
+     *
+     * @returns {Array<string>} 文本集
+     */
     fnSPLIT(text: string, sep?: string): string[];
+    /**
+     * 将文本去除前后空格
+     *
+     * @example TRIM(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 处理后的文本
+     */
     fnTRIM(text: string): string;
+    /**
+     * 判断字符串(text)是否以特定字符串(startString)开始，是则返回 True，否则返回 False
+     *
+     * @example STARTSWITH(text, '片段')
+     * @param {string} text - 文本
+     * @param {string} startString - 起始文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 判断结果
+     */
     fnSTARTSWITH(text: string, search: string): boolean;
+    /**
+     * 判断参数 1 中的文本是否包含参数 2 中的文本。
+     *
+     * @example CONTAINS(text, searchText)
+     * @param {string} text - 文本
+     * @param {string} searchText - 搜索文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 判断结果
+     */
     fnCONTAINS(text: string, search: string): boolean;
+    /**
+     * 对文本进行全量替换。
+     *
+     * @example REPLACE(text, search, replace)
+     * @param {string} text - 要处理的文本
+     * @param {string} search - 要被替换的文本
+     * @param {string} replace - 要替换的文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 处理结果
+     */
     fnREPLACE(text: string, search: string, replace: string): string;
+    /**
+     * 对文本进行搜索，返回命中的位置
+     *
+     * @example SEARCH(text, search, 0)
+     * @param {string} text - 要处理的文本
+     * @param {string} search - 用来搜索的文本
+     * @param {number} start - 起始位置
+     * @namespace 文本函数
+     *
+     * @returns {number} 命中的位置
+     */
     fnSEARCH(text: string, search: string, start?: number): number;
+    /**
+     * 返回文本字符串中从指定位置开始的特定数目的字符
+     *
+     * @example MID(text, from, len)
+     * @param {string} text - 要处理的文本
+     * @param {number} from - 起始位置
+     * @param {number} len - 处理长度
+     * @namespace 文本函数
+     *
+     * @returns {number} 命中的位置
+     */
     fnMID(text: string, from: number, len: number): string;
+    /**
+     * 创建日期对象，可以通过特定格式的字符串，或者数值。
+     *
+     * 需要注意的是，其中月份的数值是从0开始的，也就是说，
+     * 如果是12月份，你应该传入数值11。
+     *
+     * @example DATE(2021, 11, 6, 8, 20, 0)
+     * @example DATE('2021-12-06 08:20:00')
+     * @namespace 日期函数
+     *
+     * @returns {Date} 日期对象
+     */
     fnDATE(year: number, month: number, day: number, hour: number, minute: number, second: number): Date;
+    /**
+     * 返回时间的时间戳
+     *
+     * @example TIMESTAMP(date[, format = "X"])
+     * @namespace 日期函数
+     * @param {date} date 日期对象
+     * @param {string} format 时间戳格式，带毫秒传入 'x'。默认为 'X' 不带毫秒的。
+     *
+     * @returns {number} 时间戳
+     */
     fnTIMESTAMP(date: Date, format?: 'x' | 'X'): number;
+    /**
+     * 返回今天的日期
+     *
+     * @example TODAY()
+     * @namespace 日期函数
+     *
+     * @returns {number} 日期
+     */
     fnTODAY(): Date;
+    /**
+     * 返回现在的日期
+     *
+     * @example NOW()
+     * @namespace 日期函数
+     *
+     * @returns {number} 日期
+     */
     fnNOW(): 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} 日期字符串
+     */
     fnDATETOSTR(date: Date, format?: string): string;
+    /**
+     * 返回日期的指定范围的开端
+     *
+     * @namespace 日期函数
+     * @example STARTOF(date[unit = "day"])
+     * @param {date} date 日期对象
+     * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
+     * @returns {date} 新的日期对象
+     */
     fnSTARTOF(date: Date, unit?: any): Date;
+    /**
+     * 返回日期的指定范围的末尾
+     * @namespace 日期函数
+     * @example ENDOF(date[unit = "day"])
+     * @param {date} date 日期对象
+     * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
+     * @returns {date} 新的日期对象
+     */
     fnENDOF(date: Date, unit?: any): Date;
     normalizeDate(raw: any): Date;
+    /**
+     * 返回日期的年份
+     * @namespace 日期函数
+     * @example YEAR(date)
+     * @param {date} date 日期对象
+     * @returns {number} 数值
+     */
     fnYEAR(date: Date): number;
+    /**
+     * 返回日期的月份，这里就是自然月份。
+     *
+     * @namespace 日期函数
+     * @example MONTH(date)
+     * @param {date} date 日期对象
+     * @returns {number} 数值
+     */
     fnMONTH(date: Date): number;
+    /**
+     * 返回日期的天
+     * @namespace 日期函数
+     * @example DAY(date)
+     * @param {date} date 日期对象
+     * @returns {number} 数值
+     */
     fnDAY(date: Date): number;
+    /**
+     * 返回日期的小时
+     * @param {date} date 日期对象
+     * @namespace 日期函数
+     * @example HOUR(date)
+     * @returns {number} 数值
+     */
     fnHOUR(date: Date): number;
-    fnHMINUTE(date: Date): number;
+    /**
+     * 返回日期的分
+     * @param {date} date 日期对象
+     * @namespace 日期函数
+     * @example MINUTE(date)
+     * @returns {number} 数值
+     */
+    fnMINUTE(date: Date): number;
+    /**
+     * 返回日期的秒
+     * @param {date} date 日期对象
+     * @namespace 日期函数
+     * @example SECOND(date)
+     * @returns {number} 数值
+     */
     fnSECOND(date: Date): number;
+    /**
+     * 返回两个日期相差多少年
+     * @param {date} endDate 日期对象
+     * @param {date} startDate 日期对象
+     * @namespace 日期函数
+     * @example YEARS(endDate, startDate)
+     * @returns {number} 数值
+     */
     fnYEARS(endDate: Date, startDate: Date): number;
+    /**
+     * 返回两个日期相差多少分钟
+     * @param {date} endDate 日期对象
+     * @param {date} startDate 日期对象
+     * @namespace 日期函数
+     * @example MINUTES(endDate, startDate)
+     * @returns {number} 数值
+     */
     fnMINUTES(endDate: Date, startDate: Date): number;
+    /**
+     * 返回两个日期相差多少天
+     * @param {date} endDate 日期对象
+     * @param {date} startDate 日期对象
+     * @namespace 日期函数
+     * @example DAYS(endDate, startDate)
+     * @returns {number} 数值
+     */
     fnDAYS(endDate: Date, startDate: Date): number;
+    /**
+     * 返回两个日期相差多少小时
+     * @param {date} endDate 日期对象
+     * @param {date} startDate 日期对象
+     * @namespace 日期函数
+     * @example HOURS(endDate, startDate)
+     * @returns {number} 数值
+     */
     fnHOURS(endDate: Date, startDate: Date): number;
+    /**
+     * 修改日期，对日期进行加减天、月份、年等操作
+     *
+     * 示例：
+     *
+     * DATEMODIFY(A, -2, 'month')
+     *
+     * 对日期 A 进行往前减2月的操作。
+     *
+     * @param {date} date 日期对象
+     * @param {number} num 数值
+     * @param {string} unit 单位：支持年、月、天等等
+     * @namespace 日期函数
+     * @example DATEMODIFY(date, 2, 'days')
+     * @returns {date} 日期对象
+     */
     fnDATEMODIFY(date: Date, num: number, format: any): Date;
+    /**
+     * 将字符日期转成日期对象，可以指定日期格式。
+     *
+     * 示例：STRTODATE('2021/12/6', 'YYYY/MM/DD')
+     *
+     * @param {string} value 日期字符
+     * @param {string} format 日期格式
+     * @namespace 日期函数
+     * @example STRTODATE(value[, format=""])
+     * @returns {date} 日期对象
+     */
     fnSTRTODATE(value: any, format?: string): Date;
+    /**
+     * 判断两个日期，是否第一个日期在第二个日期的前面
+     *
+     * @param {date} a 第一个日期
+     * @param {date} b 第二个日期
+     * @param {string} unit 单位，默认是 'day'， 即之比较到天
+     * @namespace 日期函数
+     * @example ISBEFORE(a, b)
+     * @returns {boolean} 判断结果
+     */
     fnISBEFORE(a: Date, b: Date, unit?: any): boolean;
+    /**
+     * 判断两个日期，是否第一个日期在第二个日期的后面
+     *
+     * @param {date} a 第一个日期
+     * @param {date} b 第二个日期
+     * @param {string} unit 单位，默认是 'day'， 即之比较到天
+     * @namespace 日期函数
+     * @example ISAFTER(a, b)
+     * @returns {boolean} 判断结果
+     */
     fnISAFTER(a: Date, b: Date, unit?: any): boolean;
+    /**
+     * 判断两个日期，是否第一个日期在第二个日期的前面或者相等
+     *
+     * @param {date} a 第一个日期
+     * @param {date} b 第二个日期
+     * @param {string} unit 单位，默认是 'day'， 即之比较到天
+     * @namespace 日期函数
+     * @example ISSAMEORBEFORE(a, b)
+     * @returns {boolean} 判断结果
+     */
     fnISSAMEORBEFORE(a: Date, b: Date, unit?: any): boolean;
+    /**
+     * 判断两个日期，是否第一个日期在第二个日期的后面或者相等
+     *
+     * @param {date} a 第一个日期
+     * @param {date} b 第二个日期
+     * @param {string} unit 单位，默认是 'day'， 即之比较到天
+     * @namespace 日期函数
+     * @example ISSAMEORAFTER(a, b)
+     * @returns {boolean} 判断结果
+     */
     fnISSAMEORAFTER(a: Date, b: Date, unit?: any): boolean;
+    /**
+     * 返回数组的长度
+     *
+     * @param {Array<any>} arr 数组
+     * @namespace 其他
+     * @example COUNT(arr)
+     * @returns {boolean} 结果
+     */
     fnCOUNT(value: any): number;
 }