amis-formula 1.2.4 → 1.2.8

package/dist/evalutor.d.ts

@@ -264,7 +264,8 @@ export declare class Evaluator {
      *
      * @example IFS(condition1, result1, condition2, result2,...conditionN, resultN)
      * @param {...any} args - 条件，返回值集合
-     * @returns {any} 返回第一个满足条件的结果，没有命中的返回 false。
+     * @namespace 逻辑函数
+     * @returns {any} 第一个满足条件的结果，没有命中的返回 false。
      */
     fnIFS(...args: Array<() => any>): any;
     /**
@@ -274,7 +275,7 @@ export declare class Evaluator {
      * @param {number} num - 数值
      * @namespace 数学函数
      *
-     * @returns {number} 返回传入数值的绝对值
+     * @returns {number} 传入数值的绝对值
      */
     fnABS(a: number): number;
     /**
@@ -284,7 +285,7 @@ export declare class Evaluator {
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
-     * @returns {number} 返回所有传入值中最大的那个
+     * @returns {number} 所有传入值中最大的那个
      */
     fnMAX(...args: Array<any>): any;
     /**
@@ -294,7 +295,7 @@ export declare class Evaluator {
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
-     * @returns {number} 返回所有传入值中最小的那个
+     * @returns {number} 所有传入值中最小的那个
      */
     fnMIN(...args: Array<number>): any;
     /**
@@ -304,7 +305,7 @@ export declare class Evaluator {
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
-     * @returns {number} 返回所有传入数值的总和
+     * @returns {number} 所有传入数值的总和
      */
     fnSUM(...args: Array<number>): any;
     /**
@@ -314,7 +315,7 @@ export declare class Evaluator {
      * @param {number} num - 数值
      * @namespace 数学函数
      *
-     * @returns {number} 返回数值对应的整形
+     * @returns {number} 数值对应的整形
      */
     fnINT(n: number): number;
     /**
@@ -325,7 +326,7 @@ export declare class Evaluator {
      * @param {number} divisor - 除数
      * @namespace 数学函数
      *
-     * @returns {number} 返回两数相除的余数
+     * @returns {number} 两数相除的余数
      */
     fnMOD(a: number, b: number): number;
     /**
@@ -334,7 +335,7 @@ export declare class Evaluator {
      * @example PI()
      * @namespace 数学函数
      *
-     * @returns {number} 返回圆周率数值
+     * @returns {number} 圆周率数值
      */
     fnPI(): number;
     /**
@@ -345,7 +346,7 @@ export declare class Evaluator {
      * @param {number} numDigits - 小数位数
      * @namespace 数学函数
      *
-     * @returns {number} 返回传入数值四舍五入后的结果
+     * @returns {number} 传入数值四舍五入后的结果
      */
     fnROUND(a: number, b: number): number;
     /**
@@ -356,7 +357,7 @@ export declare class Evaluator {
      * @param {number} numDigits - 小数位数
      * @namespace 数学函数
      *
-     * @returns {number} 返回传入数值向下取整后的结果
+     * @returns {number} 传入数值向下取整后的结果
      */
     fnFLOOR(a: number, b: number): number;
     /**
@@ -367,7 +368,7 @@ export declare class Evaluator {
      * @param {number} numDigits - 小数位数
      * @namespace 数学函数
      *
-     * @returns {number} 返回传入数值向上取整后的结果
+     * @returns {number} 传入数值向上取整后的结果
      */
     fnCEIL(a: number, b: number): number;
     /**
@@ -377,7 +378,7 @@ export declare class Evaluator {
      * @param {number} num - 要处理的数字
      * @namespace 数学函数
      *
-     * @returns {number} 返回开平方的结果
+     * @returns {number} 开平方的结果
      */
     fnSQRT(n: number): number;
     /**
@@ -387,9 +388,50 @@ export declare class Evaluator {
      * @param {...number} num - 要处理的数字
      * @namespace 数学函数
      *
-     * @returns {number} 返回所有数值的平均值
+     * @returns {number} 所有数值的平均值
      */
     fnAVG(...args: Array<any>): number;
+    /**
+     * 返回数据点与数据均值点之差（数据偏差）的平方和
+     *
+     * @example DEVSQ(num1, num2, ...numN)
+     * @param {...number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有数值的平均值
+     */
+    fnDEVSQ(...args: Array<any>): number | null;
+    /**
+     * 数据点到其算术平均值的绝对偏差的平均值
+     *
+     * @example AVEDEV(num1, num2, ...numN)
+     * @param {...number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有数值的平均值
+     */
+    fnAVEDEV(...args: Array<any>): number | null;
+    /**
+     * 数据点的调和平均值
+     *
+     * @example HARMEAN(num1, num2, ...numN)
+     * @param {...number} num - 要处理的数字
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有数值的平均值
+     */
+    fnHARMEAN(...args: Array<any>): number | null;
+    /**
+     * 数据集中第 k 个最大值
+     *
+     * @example LARGE(array, k)
+     * @param {array} nums - 要处理的数字
+     * @param {number}  k - 第几大
+     * @namespace 数学函数
+     *
+     * @returns {number} 所有数值的平均值
+     */
+    fnLARGE(nums: Array<any>, k: number): any;
     /**
      * 将数值转为中文大写金额
      *
@@ -397,7 +439,7 @@ export declare class Evaluator {
      * @param {number} num - 要处理的数字
      * @namespace 数学函数
      *
-     * @returns {string} 返回数值中文大写字符
+     * @returns {string} 数值中文大写字符
      */
     fnUPPERMONEY(n: number): string;
     /**
@@ -410,7 +452,7 @@ export declare class Evaluator {
      * @example RAND()
      * @namespace 数学函数
      *
-     * @returns {number} 返回随机数
+     * @returns {number} 随机数
      */
     fnRAND(): number;
     normalizeText(raw: any): string;
@@ -453,7 +495,7 @@ export declare class Evaluator {
      * @param {string[]} textArr - 要处理的文本集合
      * @namespace 文本函数
      *
-     * @returns {number[]} 返回长度集合
+     * @returns {number[]} 长度集合
      */
     fnLENGTH(...args: any[]): any;
     /**
@@ -463,7 +505,7 @@ export declare class Evaluator {
      * @param {string} text - 要处理的文本
      * @namespace 文本函数
      *
-     * @returns {boolean} 返回判断结果
+     * @returns {boolean} 判断结果
      */
     fnISEMPTY(text: string): boolean;
     /**
@@ -473,7 +515,7 @@ export declare class Evaluator {
      * @param {...string} text - 文本集合
      * @namespace 文本函数
      *
-     * @returns {string} 返回连接后的文本
+     * @returns {string} 连接后的文本
      */
     fnCONCATENATE(...args: Array<any>): string;
     /**
@@ -485,7 +527,7 @@ export declare class Evaluator {
      * @param {number} code - 编码值
      * @namespace 文本函数
      *
-     * @returns {string} 返回指定位置的字符
+     * @returns {string} 指定位置的字符
      */
     fnCHAR(code: number): string;
     /**
@@ -495,7 +537,7 @@ export declare class Evaluator {
      * @param {string} text - 文本
      * @namespace 文本函数
      *
-     * @returns {string} 返回结果文本
+     * @returns {string} 结果文本
      */
     fnLOWER(text: string): string;
     /**
@@ -505,9 +547,89 @@ export declare class Evaluator {
      * @param {string} text - 文本
      * @namespace 文本函数
      *
-     * @returns {string} 返回结果文本
+     * @returns {string} 结果文本
      */
     fnUPPER(text: string): string;
+    /**
+     * 将传入文本首字母转成大写
+     *
+     * @example UPPERFIRST(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
+    fnUPPERFIRST(text: string): string;
+    /**
+     * 向前补齐文本长度
+     *
+     * 示例 `PADSTART("6", 2, "0")`
+     *
+     * 返回 `06`
+     *
+     * @example PADSTART(text)
+     * @param {string} text - 文本
+     * @param {number} num - 目标长度
+     * @param {string} pad - 用于补齐的文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
+    fnPADSTART(text: string, num: number, pad: string): string;
+    /**
+     * 将文本转成标题
+     *
+     * 示例 `CAPITALIZE("star")`
+     *
+     * 返回 `Star`
+     *
+     * @example CAPITALIZE(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
+    fnCAPITALIZE(text: string): string;
+    /**
+     * 对文本进行 HTML 转义
+     *
+     * 示例 `ESCAPE("star")`
+     *
+     * 返回 `Star`
+     *
+     * @example ESCAPE(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
+    fnESCAPE(text: string): string;
+    /**
+     * 对文本长度进行截断
+     *
+     * 示例 `TRUNCATE("amis.baidu.com", 6)`
+     *
+     * 返回 `amis...`
+     *
+     * @example TRUNCATE(text, 6)
+     * @param {string} text - 文本
+     * @param {number} text - 最长长度
+     * @namespace 文本函数
+     *
+     * @returns {string} 结果文本
+     */
+    fnTRUNCATE(text: string, length: number): string;
+    /**
+     *  取在某个分隔符之前的所有字符串
+     *
+     * @example  BEFORELAST(text, '.')
+     * @param {string} text - 文本
+     * @param {string} delimiter - 结束文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 判断结果
+     */
+    fnBEFORELAST(text: string, delimiter?: string): string;
     /**
      * 将文本根据指定片段分割成数组
      *
@@ -520,7 +642,7 @@ export declare class Evaluator {
      * @param {string} delimiter - 文本片段
      * @namespace 文本函数
      *
-     * @returns {Array<string>} 返回文本集
+     * @returns {Array<string>} 文本集
      */
     fnSPLIT(text: string, sep?: string): string[];
     /**
@@ -530,9 +652,37 @@ export declare class Evaluator {
      * @param {string} text - 文本
      * @namespace 文本函数
      *
-     * @returns {string} 返回处理后的文本
+     * @returns {string} 处理后的文本
      */
     fnTRIM(text: string): string;
+    /**
+     * 去除文本中的 HTML 标签
+     *
+     * 示例：`STRIPTAG("<b>amis</b>")`
+     *
+     * 返回：`amis`
+     *
+     * @example STRIPTAG(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 处理后的文本
+     */
+    fnSTRIPTAG(text: string): string;
+    /**
+     * 将字符串中的换行转成 HTML `<br>`，用于简单换行的场景
+     *
+     * 示例：`LINEBREAK("\n")`
+     *
+     * 返回：`<br/>`
+     *
+     * @example LINEBREAK(text)
+     * @param {string} text - 文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 处理后的文本
+     */
+    fnLINEBREAK(text: string): string;
     /**
      * 判断字符串(text)是否以特定字符串(startString)开始，是则返回 True，否则返回 False
      *
@@ -541,9 +691,20 @@ export declare class Evaluator {
      * @param {string} startString - 起始文本
      * @namespace 文本函数
      *
-     * @returns {string} 返回判断结果
+     * @returns {string} 判断结果
      */
     fnSTARTSWITH(text: string, search: string): boolean;
+    /**
+     * 判断字符串(text)是否以特定字符串(endString)结束，是则返回 True，否则返回 False
+     *
+     * @example ENDSWITH(text, '片段')
+     * @param {string} text - 文本
+     * @param {string} endString - 结束文本
+     * @namespace 文本函数
+     *
+     * @returns {string} 判断结果
+     */
+    fnENDSWITH(text: string, search: string): boolean;
     /**
      * 判断参数 1 中的文本是否包含参数 2 中的文本。
      *
@@ -552,7 +713,7 @@ export declare class Evaluator {
      * @param {string} searchText - 搜索文本
      * @namespace 文本函数
      *
-     * @returns {string} 返回判断结果
+     * @returns {string} 判断结果
      */
     fnCONTAINS(text: string, search: string): boolean;
     /**
@@ -564,7 +725,7 @@ export declare class Evaluator {
      * @param {string} replace - 要替换的文本
      * @namespace 文本函数
      *
-     * @returns {string} 返回处理结果
+     * @returns {string} 处理结果
      */
     fnREPLACE(text: string, search: string, replace: string): string;
     /**
@@ -576,7 +737,7 @@ export declare class Evaluator {
      * @param {number} start - 起始位置
      * @namespace 文本函数
      *
-     * @returns {number} 返回命中的位置
+     * @returns {number} 命中的位置
      */
     fnSEARCH(text: string, search: string, start?: number): number;
     /**
@@ -588,7 +749,7 @@ export declare class Evaluator {
      * @param {number} len - 处理长度
      * @namespace 文本函数
      *
-     * @returns {number} 返回命中的位置
+     * @returns {number} 命中的位置
      */
     fnMID(text: string, from: number, len: number): string;
     /**
@@ -601,7 +762,7 @@ export declare class Evaluator {
      * @example DATE('2021-12-06 08:20:00')
      * @namespace 日期函数
      *
-     * @returns {Date} 返回日期对象
+     * @returns {Date} 日期对象
      */
     fnDATE(year: number, month: number, day: number, hour: number, minute: number, second: number): Date;
     /**
@@ -612,7 +773,7 @@ export declare class Evaluator {
      * @param {date} date 日期对象
      * @param {string} format 时间戳格式，带毫秒传入 'x'。默认为 'X' 不带毫秒的。
      *
-     * @returns {number} 返回时间戳
+     * @returns {number} 时间戳
      */
     fnTIMESTAMP(date: Date, format?: 'x' | 'X'): number;
     /**
@@ -621,7 +782,7 @@ export declare class Evaluator {
      * @example TODAY()
      * @namespace 日期函数
      *
-     * @returns {number} 返回日期
+     * @returns {number} 日期
      */
     fnTODAY(): Date;
     /**
@@ -630,7 +791,7 @@ export declare class Evaluator {
      * @example NOW()
      * @namespace 日期函数
      *
-     * @returns {number} 返回日期
+     * @returns {number} 日期
      */
     fnNOW(): Date;
     /**
@@ -641,7 +802,7 @@ export declare class Evaluator {
      * @param {date} date 日期对象
      * @param {string} format 日期格式，默认为 "YYYY-MM-DD HH:mm:ss"
      *
-     * @returns {number} 返回日期字符串
+     * @returns {number} 日期字符串
      */
     fnDATETOSTR(date: Date, format?: string): string;
     /**
@@ -669,7 +830,7 @@ export declare class Evaluator {
      * @namespace 日期函数
      * @example YEAR(date)
      * @param {date} date 日期对象
-     * @returns {number} 返回数值
+     * @returns {number} 数值
      */
     fnYEAR(date: Date): number;
     /**
@@ -678,7 +839,7 @@ export declare class Evaluator {
      * @namespace 日期函数
      * @example MONTH(date)
      * @param {date} date 日期对象
-     * @returns {number} 返回数值
+     * @returns {number} 数值
      */
     fnMONTH(date: Date): number;
     /**
@@ -686,7 +847,7 @@ export declare class Evaluator {
      * @namespace 日期函数
      * @example DAY(date)
      * @param {date} date 日期对象
-     * @returns {number} 返回数值
+     * @returns {number} 数值
      */
     fnDAY(date: Date): number;
     /**
@@ -694,7 +855,7 @@ export declare class Evaluator {
      * @param {date} date 日期对象
      * @namespace 日期函数
      * @example HOUR(date)
-     * @returns {number} 返回数值
+     * @returns {number} 数值
      */
     fnHOUR(date: Date): number;
     /**
@@ -702,7 +863,7 @@ export declare class Evaluator {
      * @param {date} date 日期对象
      * @namespace 日期函数
      * @example MINUTE(date)
-     * @returns {number} 返回数值
+     * @returns {number} 数值
      */
     fnMINUTE(date: Date): number;
     /**
@@ -710,7 +871,7 @@ export declare class Evaluator {
      * @param {date} date 日期对象
      * @namespace 日期函数
      * @example SECOND(date)
-     * @returns {number} 返回数值
+     * @returns {number} 数值
      */
     fnSECOND(date: Date): number;
     /**
@@ -719,7 +880,7 @@ export declare class Evaluator {
      * @param {date} startDate 日期对象
      * @namespace 日期函数
      * @example YEARS(endDate, startDate)
-     * @returns {number} 返回数值
+     * @returns {number} 数值
      */
     fnYEARS(endDate: Date, startDate: Date): number;
     /**
@@ -728,7 +889,7 @@ export declare class Evaluator {
      * @param {date} startDate 日期对象
      * @namespace 日期函数
      * @example MINUTES(endDate, startDate)
-     * @returns {number} 返回数值
+     * @returns {number} 数值
      */
     fnMINUTES(endDate: Date, startDate: Date): number;
     /**
@@ -737,7 +898,7 @@ export declare class Evaluator {
      * @param {date} startDate 日期对象
      * @namespace 日期函数
      * @example DAYS(endDate, startDate)
-     * @returns {number} 返回数值
+     * @returns {number} 数值
      */
     fnDAYS(endDate: Date, startDate: Date): number;
     /**
@@ -746,7 +907,7 @@ export declare class Evaluator {
      * @param {date} startDate 日期对象
      * @namespace 日期函数
      * @example HOURS(endDate, startDate)
-     * @returns {number} 返回数值
+     * @returns {number} 数值
      */
     fnHOURS(endDate: Date, startDate: Date): number;
     /**
@@ -763,7 +924,7 @@ export declare class Evaluator {
      * @param {string} unit 单位：支持年、月、天等等
      * @namespace 日期函数
      * @example DATEMODIFY(date, 2, 'days')
-     * @returns {date} 返回日期对象
+     * @returns {date} 日期对象
      */
     fnDATEMODIFY(date: Date, num: number, format: any): Date;
     /**
@@ -775,7 +936,7 @@ export declare class Evaluator {
      * @param {string} format 日期格式
      * @namespace 日期函数
      * @example STRTODATE(value[, format=""])
-     * @returns {date} 返回日期对象
+     * @returns {date} 日期对象
      */
     fnSTRTODATE(value: any, format?: string): Date;
     /**
@@ -786,7 +947,7 @@ export declare class Evaluator {
      * @param {string} unit 单位，默认是 'day'， 即之比较到天
      * @namespace 日期函数
      * @example ISBEFORE(a, b)
-     * @returns {boolean}} 返回判断结果
+     * @returns {boolean} 判断结果
      */
     fnISBEFORE(a: Date, b: Date, unit?: any): boolean;
     /**
@@ -797,7 +958,7 @@ export declare class Evaluator {
      * @param {string} unit 单位，默认是 'day'， 即之比较到天
      * @namespace 日期函数
      * @example ISAFTER(a, b)
-     * @returns {boolean}} 返回判断结果
+     * @returns {boolean} 判断结果
      */
     fnISAFTER(a: Date, b: Date, unit?: any): boolean;
     /**
@@ -808,7 +969,7 @@ export declare class Evaluator {
      * @param {string} unit 单位，默认是 'day'， 即之比较到天
      * @namespace 日期函数
      * @example ISSAMEORBEFORE(a, b)
-     * @returns {boolean}} 返回判断结果
+     * @returns {boolean} 判断结果
      */
     fnISSAMEORBEFORE(a: Date, b: Date, unit?: any): boolean;
     /**
@@ -819,7 +980,7 @@ export declare class Evaluator {
      * @param {string} unit 单位，默认是 'day'， 即之比较到天
      * @namespace 日期函数
      * @example ISSAMEORAFTER(a, b)
-     * @returns {boolean}} 返回判断结果
+     * @returns {boolean} 判断结果
      */
     fnISSAMEORAFTER(a: Date, b: Date, unit?: any): boolean;
     /**
@@ -828,7 +989,7 @@ export declare class Evaluator {
      * @param {Array<any>} arr 数组
      * @namespace 其他
      * @example COUNT(arr)
-     * @returns {boolean} 返回结果
+     * @returns {boolean} 结果
      */
     fnCOUNT(value: any): number;
 }