amis-formula 6.9.0 → 6.10.0-beta.0

package/esm/doc.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.9.0
+ * amis-formula v6.10.0-beta.0
  * Copyright 2021-2024 fex
  */
 
@@ -129,7 +129,7 @@ bulkRegisterFunctionDoc([
     {
         name: "MAX",
         description: "获取最大值，如果只有一个参数且是数组，则计算这个数组内的值。",
-        example: "MAX(num1, num2, ...numN)",
+        example: "MAX(num1, num2, ...numN) or MAX([num1, num2, ...numN])",
         params: [
             {
                 type: "...number",
@@ -146,7 +146,7 @@ bulkRegisterFunctionDoc([
     {
         name: "MIN",
         description: "获取最小值，如果只有一个参数且是数组，则计算这个数组内的值。",
-        example: "MIN(num1, num2, ...numN)",
+        example: "MIN(num1, num2, ...numN) or MIN([num1, num2, ...numN])",
         params: [
             {
                 type: "...number",
@@ -163,7 +163,7 @@ bulkRegisterFunctionDoc([
     {
         name: "SUM",
         description: "求和，如果只有一个参数且是数组，则计算这个数组内的值。",
-        example: "SUM(num1, num2, ...numN)",
+        example: "SUM(num1, num2, ...numN) or SUM([num1, num2, ...numN])",
         params: [
             {
                 type: "...number",
@@ -313,7 +313,7 @@ bulkRegisterFunctionDoc([
     {
         name: "AVG",
         description: "返回所有参数的平均值，如果只有一个参数且是数组，则计算这个数组内的值。",
-        example: "AVG(num1, num2, ...numN)",
+        example: "AVG(num1, num2, ...numN) or AVG([num1, num2, ...numN])",
         params: [
             {
                 type: "...number",
@@ -842,7 +842,7 @@ bulkRegisterFunctionDoc([
             }
         ],
         returns: {
-            type: "string",
+            type: "boolean",
             description: "判断结果"
         },
         namespace: "文本函数"
@@ -864,7 +864,7 @@ bulkRegisterFunctionDoc([
             }
         ],
         returns: {
-            type: "string",
+            type: "boolean",
             description: "判断结果"
         },
         namespace: "文本函数"
@@ -886,7 +886,7 @@ bulkRegisterFunctionDoc([
             }
         ],
         returns: {
-            type: "string",
+            type: "boolean",
             description: "判断结果"
         },
         namespace: "文本函数"
@@ -947,7 +947,7 @@ bulkRegisterFunctionDoc([
     },
     {
         name: "MID",
-        description: "返回文本字符串中从指定位置开始的特定数目的字符。",
+        description: "返回文本字符串中从指定位置开始的特定数目的字符。\n\n示例：`MID(\"amis.baidu.com\", 6, 3)`，\n\n返回 `aid`。",
         example: "MID(text, from, len)",
         params: [
             {
@@ -967,14 +967,14 @@ bulkRegisterFunctionDoc([
             }
         ],
         returns: {
-            type: "number",
+            type: "string",
             description: "命中的位置"
         },
         namespace: "文本函数"
     },
     {
         name: "BASENAME",
-        description: "返回路径中的文件名。\n\n示例：`/home/amis/a.json`，\n\n返回：a.json`。",
+        description: "返回路径中的文件名。\n\n示例：`/home/amis/a.json`，\n\n返回：`a.json`。",
         example: "BASENAME(text)",
         params: [
             {
@@ -1181,8 +1181,8 @@ bulkRegisterFunctionDoc([
             }
         ],
         returns: {
-            type: "date",
-            description: "新的日期对象"
+            type: "any",
+            description: "新的日期对象, 如果传入 format 则返回格式化后的日期字符串"
         },
         namespace: "日期函数"
     },
@@ -1208,8 +1208,8 @@ bulkRegisterFunctionDoc([
             }
         ],
         returns: {
-            type: "date",
-            description: "新的日期对象"
+            type: "any",
+            description: "新的日期对象, 如果传入 format 则返回格式化后的日期字符串"
         },
         namespace: "日期函数"
     },
@@ -1604,14 +1604,14 @@ bulkRegisterFunctionDoc([
             }
         ],
         returns: {
-            type: "boolean",
+            type: "number",
             description: "结果"
         },
         namespace: "数组"
     },
     {
         name: "ARRAYMAP",
-        description: "数组做数据转换，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。",
+        description: "数组做数据转换，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。\n\n将数组中的每个元素转换成箭头函数返回的值。\n\n示例：\n\nARRAYMAP([1, 2, 3], item => item + 1) 得到 [2, 3, 4]。",
         example: "ARRAYMAP(arr, item => item)",
         params: [
             {
@@ -1626,14 +1626,14 @@ bulkRegisterFunctionDoc([
             }
         ],
         returns: {
-            type: "boolean",
-            description: "结果"
+            type: "Array<any>",
+            description: "返回转换后的数组"
         },
         namespace: "数组"
     },
     {
         name: "ARRAYFILTER",
-        description: "数据做数据过滤，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。\n将第二个箭头函数返回为 false 的成员过滤掉。",
+        description: "数据做数据过滤，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。\n将第二个箭头函数返回为 false 的成员过滤掉。\n\n示例：\n\nARRAYFILTER([1, 2, 3], item => item > 1) 得到 [2, 3]。",
         example: "ARRAYFILTER(arr, item => item)",
         params: [
             {
@@ -1648,8 +1648,8 @@ bulkRegisterFunctionDoc([
             }
         ],
         returns: {
-            type: "boolean",
-            description: "结果"
+            type: "Array<any>",
+            description: "返回过滤后的数组"
         },
         namespace: "数组"
     },
@@ -1797,7 +1797,7 @@ bulkRegisterFunctionDoc([
             }
         ],
         returns: {
-            type: "String",
+            type: "string",
             description: "结果"
         },
         namespace: "数组"
@@ -1821,7 +1821,7 @@ bulkRegisterFunctionDoc([
     },
     {
         name: "UNIQ",
-        description: "数组去重，第二个参数「field」，可指定根据该字段去重。\n\n示例：\n\nUNIQ([{a: '1'}, {b: '2'}, {a: '1'}]， 'id')。",
+        description: "数组去重，第二个参数「field」，可指定根据该字段去重。\n\n示例：\n\nUNIQ([{a: '1'}, {b: '2'}, {a: '1'}]) 得到 [{a: '1'}, {b: '2'}]。",
         example: "UNIQ([{a: '1'}, {b: '2'}, {a: '1'}], 'x')",
         params: [
             {

package/esm/doc.md

@@ -89,7 +89,7 @@
 
 ### MAX
 
-用法：`MAX(num1, num2, ...numN)`
+用法：`MAX(num1, num2, ...numN) or MAX([num1, num2, ...numN])`
 
  * `num:...number` 数值
 
@@ -99,7 +99,7 @@
 
 ### MIN
 
-用法：`MIN(num1, num2, ...numN)`
+用法：`MIN(num1, num2, ...numN) or MIN([num1, num2, ...numN])`
 
  * `num:...number` 数值
 
@@ -109,7 +109,7 @@
 
 ### SUM
 
-用法：`SUM(num1, num2, ...numN)`
+用法：`SUM(num1, num2, ...numN) or SUM([num1, num2, ...numN])`
 
  * `num:...number` 数值
 
@@ -189,7 +189,7 @@
 
 ### AVG
 
-用法：`AVG(num1, num2, ...numN)`
+用法：`AVG(num1, num2, ...numN) or AVG([num1, num2, ...numN])`
 
  * `num:...number` 要处理的数字
 
@@ -515,7 +515,7 @@
  * `text:string` 文本
  * `startString:string` 起始文本
 
-返回：`string` 判断结果
+返回：`boolean` 判断结果
 
 判断字符串(text)是否以特定字符串(startString)开始，是则返回 true，否则返回 false。
 
@@ -526,7 +526,7 @@
  * `text:string` 文本
  * `endString:string` 结束文本
 
-返回：`string` 判断结果
+返回：`boolean` 判断结果
 
 判断字符串(text)是否以特定字符串(endString)结束，是则返回 true，否则返回 false。
 
@@ -537,7 +537,7 @@
  * `text:string` 文本
  * `searchText:string` 搜索文本
 
-返回：`string` 判断结果
+返回：`boolean` 判断结果
 
 判断参数 1 中的文本是否包含参数 2 中的文本，是则返回 true，否则返回 false。
 
@@ -573,10 +573,14 @@
  * `from:number` 起始位置
  * `len:number` 处理长度
 
-返回：`number` 命中的位置
+返回：`string` 命中的位置
 
 返回文本字符串中从指定位置开始的特定数目的字符。
 
+示例：`MID("amis.baidu.com", 6, 3)`，
+
+返回 `aid`。
+
 ### BASENAME
 
 用法：`BASENAME(text)`
@@ -589,7 +593,7 @@
 
 示例：`/home/amis/a.json`，
 
-返回：a.json`。
+返回：`a.json`。
 
 ### UUID
 
@@ -714,7 +718,7 @@ DATERANGESPLIT('1676563200, 1676735999', 'end' , 'YYYY.MM.DD hh:mm:ss') 得到 '
  * `unit:string` 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
  * `format:string` 日期格式，可选
 
-返回：`date` 新的日期对象
+返回：`any` 新的日期对象, 如果传入 format 则返回格式化后的日期字符串
 
 返回日期的指定范围的开端。
 
@@ -726,7 +730,7 @@ DATERANGESPLIT('1676563200, 1676735999', 'end' , 'YYYY.MM.DD hh:mm:ss') 得到 '
  * `unit:string` 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
  * `format:string` 日期格式，可选
 
-返回：`date` 新的日期对象
+返回：`any` 新的日期对象, 如果传入 format 则返回格式化后的日期字符串
 
 返回日期的指定范围的末尾。
 
@@ -936,7 +940,7 @@ DATEMODIFY(A, -2, 'month')，
 
  * `arr:Array<any>` 数组
 
-返回：`boolean` 结果
+返回：`number` 结果
 
 返回数组的长度。
 
@@ -947,10 +951,16 @@ DATEMODIFY(A, -2, 'month')，
  * `arr:Array<any>` 数组
  * `iterator:Array<any>` 箭头函数
 
-返回：`boolean` 结果
+返回：`Array<any>` 返回转换后的数组
 
 数组做数据转换，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
 
+将数组中的每个元素转换成箭头函数返回的值。
+
+示例：
+
+ARRAYMAP([1, 2, 3], item => item + 1) 得到 [2, 3, 4]。
+
 ### ARRAYFILTER
 
 用法：`ARRAYFILTER(arr, item => item)`
@@ -958,11 +968,15 @@ DATEMODIFY(A, -2, 'month')，
  * `arr:Array<any>` 数组
  * `iterator:Array<any>` 箭头函数
 
-返回：`boolean` 结果
+返回：`Array<any>` 返回过滤后的数组
 
 数据做数据过滤，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
 将第二个箭头函数返回为 false 的成员过滤掉。
 
+示例：
+
+ARRAYFILTER([1, 2, 3], item => item > 1) 得到 [2, 3]。
+
 ### ARRAYFINDINDEX
 
 用法：`ARRAYFINDINDEX(arr, item => item === 2)`
@@ -1063,7 +1077,7 @@ COMPACT([0, 1, false, 2, '', 3]) 得到 [1, 2, 3]。
  * `arr:Array<any>` 数组
  * `separator:String` 分隔符
 
-返回：`String` 结果
+返回：`string` 结果
 
 数组转成字符串。
 
@@ -1098,7 +1112,7 @@ CONCAT(['a', 'b', 'c'], ['1'], ['3']) 得到 ['a', 'b', 'c', '1', '3']。
 
 示例：
 
-UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]， 'id')。
+UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]) 得到 [{a: '1'}, {b: '2'}]。
 
 ## 编码
 

package/esm/error.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v6.9.0
+ * amis-formula v6.10.0-beta.0
  * Copyright 2021-2024 fex
  */
 

package/esm/evalutor.d.ts

@@ -281,7 +281,7 @@ export declare class Evaluator {
     /**
      * 获取最大值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example MAX(num1, num2, ...numN)
+     * @example MAX(num1, num2, ...numN) or MAX([num1, num2, ...numN])
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
@@ -291,7 +291,7 @@ export declare class Evaluator {
     /**
      * 获取最小值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example MIN(num1, num2, ...numN)
+     * @example MIN(num1, num2, ...numN) or MIN([num1, num2, ...numN])
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
@@ -301,7 +301,7 @@ export declare class Evaluator {
     /**
      * 求和，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example SUM(num1, num2, ...numN)
+     * @example SUM(num1, num2, ...numN) or SUM([num1, num2, ...numN])
      * @param {...number} num - 数值
      * @namespace 数学函数
      *
@@ -384,7 +384,7 @@ export declare class Evaluator {
     /**
      * 返回所有参数的平均值，如果只有一个参数且是数组，则计算这个数组内的值。
      *
-     * @example AVG(num1, num2, ...numN)
+     * @example AVG(num1, num2, ...numN) or AVG([num1, num2, ...numN])
      * @param {...number} num - 要处理的数字
      * @namespace 数学函数
      *
@@ -580,7 +580,7 @@ export declare class Evaluator {
      *
      * @returns {string} 结果文本
      */
-    fnUPPERFIRST(text: string): string;
+    fnUPPERFIRST(text: string): Capitalize<string>;
     /**
      * 向前补齐文本长度。
      *
@@ -712,7 +712,7 @@ export declare class Evaluator {
      * @param {string} startString - 起始文本
      * @namespace 文本函数
      *
-     * @returns {string} 判断结果
+     * @returns {boolean} 判断结果
      */
     fnSTARTSWITH(text: string, search: string): boolean;
     /**
@@ -723,7 +723,7 @@ export declare class Evaluator {
      * @param {string} endString - 结束文本
      * @namespace 文本函数
      *
-     * @returns {string} 判断结果
+     * @returns {boolean} 判断结果
      */
     fnENDSWITH(text: string, search: string): boolean;
     /**
@@ -734,7 +734,7 @@ export declare class Evaluator {
      * @param {string} searchText - 搜索文本
      * @namespace 文本函数
      *
-     * @returns {string} 判断结果
+     * @returns {boolean} 判断结果
      */
     fnCONTAINS(text: string, search: string): boolean;
     /**
@@ -764,13 +764,17 @@ export declare class Evaluator {
     /**
      * 返回文本字符串中从指定位置开始的特定数目的字符。
      *
+     * 示例：`MID("amis.baidu.com", 6, 3)`，
+     *
+     * 返回 `aid`。
+     *
      * @example MID(text, from, len)
      * @param {string} text - 要处理的文本
      * @param {number} from - 起始位置
      * @param {number} len - 处理长度
      * @namespace 文本函数
      *
-     * @returns {number} 命中的位置
+     * @returns {string} 命中的位置
      */
     fnMID(text: string, from: number, len: number): string;
     /**
@@ -778,7 +782,7 @@ export declare class Evaluator {
      *
      * 示例：`/home/amis/a.json`，
      *
-     * 返回：a.json`。
+     * 返回：`a.json`。
      *
      * @example BASENAME(text)
      * @param {string} text - 要处理的文本
@@ -919,7 +923,7 @@ export declare class Evaluator {
      * @param {date} date 日期对象
      * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
      * @param {string} format 日期格式，可选
-     * @returns {date} 新的日期对象
+     * @returns {any} 新的日期对象, 如果传入 format 则返回格式化后的日期字符串
      */
     fnSTARTOF(date: Date, unit?: any, format?: string): string | Date;
     /**
@@ -930,7 +934,7 @@ export declare class Evaluator {
      * @param {date} date 日期对象
      * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
      * @param {string} format 日期格式，可选
-     * @returns {date} 新的日期对象
+     * @returns {any} 新的日期对象, 如果传入 format 则返回格式化后的日期字符串
      */
     fnENDOF(date: Date, unit?: any, format?: string): string | Date;
     normalizeDate(raw: any): Date;
@@ -1122,28 +1126,38 @@ export declare class Evaluator {
      * @param {Array<any>} arr 数组
      * @namespace 数组
      * @example COUNT(arr)
-     * @returns {boolean} 结果
+     * @returns {number} 结果
      */
     fnCOUNT(value: any): number;
     /**
      * 数组做数据转换，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
      *
+     * 将数组中的每个元素转换成箭头函数返回的值。
+     *
+     * 示例：
+     *
+     * ARRAYMAP([1, 2, 3], item => item + 1) 得到 [2, 3, 4]。
+     *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
      * @namespace 数组
      * @example ARRAYMAP(arr, item => item)
-     * @returns {boolean} 结果
+     * @returns {Array<any>} 返回转换后的数组
      */
     fnARRAYMAP(value: any, iterator: any): any[];
     /**
      * 数据做数据过滤，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
      * 将第二个箭头函数返回为 false 的成员过滤掉。
      *
+     * 示例：
+     *
+     * ARRAYFILTER([1, 2, 3], item => item > 1) 得到 [2, 3]。
+     *
      * @param {Array<any>} arr 数组
      * @param {Function<any>} iterator 箭头函数
      * @namespace 数组
      * @example ARRAYFILTER(arr, item => item)
-     * @returns {boolean} 结果
+     * @returns {Array<any>} 返回过滤后的数组
      */
     fnARRAYFILTER(value: any, iterator: any): any[];
     /**
@@ -1244,7 +1258,7 @@ export declare class Evaluator {
      * @param { String} separator 分隔符
      * @namespace 数组
      * @example JOIN(arr, string)
-     * @returns {String} 结果
+     * @returns {string} 结果
      */
     fnJOIN(arr: any[], separator?: string): string;
     /**
@@ -1265,7 +1279,7 @@ export declare class Evaluator {
      *
      * 示例：
      *
-     * UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]， 'id')。
+     * UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]) 得到 [{a: '1'}, {b: '2'}]。
      *
      * @param {Array<any>} arr 数组
      * @param {string} field 字段