amis-formula 2.7.2 → 2.8.0

package/lib/doc.js

@@ -1,5 +1,5 @@
 /**
- * amis-formula v2.7.2
+ * amis-formula v2.8.0
  * Copyright 2021-2023 fex
  */
 
@@ -1024,15 +1024,59 @@ var doc = [
         },
         namespace: "日期函数"
     },
+    {
+        name: "WEEKDAY",
+        description: "获取日期的星期几，\n\n示例：\n\nWEEKDAY('2023-02-27') 得到 1",
+        example: "WEEKDAY(date)",
+        params: [
+            {
+                type: "any",
+                name: "date",
+                description: "日期"
+            },
+            {
+                type: "number",
+                name: "type",
+                description: "星期定义类型，默认为1，1表示0至6代表星期一到星期日，2表示1至7代表星期一到星期日"
+            }
+        ],
+        returns: {
+            type: "number",
+            description: "星期几的数字标识"
+        },
+        namespace: "日期函数"
+    },
+    {
+        name: "WEEK",
+        description: "获取年份的星期，即第几周\n\n示例：\n\nWEEK('2023-03-05') 得到 10",
+        example: "WEEK(date)",
+        params: [
+            {
+                type: "any",
+                name: "date",
+                description: "日期"
+            },
+            {
+                type: "boolean",
+                name: "isISO",
+                description: "是否ISO星期"
+            }
+        ],
+        returns: {
+            type: "number",
+            description: "星期几的数字标识"
+        },
+        namespace: "日期函数"
+    },
     {
         name: "DATETOSTR",
-        description: "将日期转成日期字符串",
+        description: "对日期、日期字符串、时间戳进行格式化\n\n示例：\n\nDATETOSTR('12/25/2022', 'YYYY-MM-DD') 得到 '2022.12.25'\nDATETOSTR(1676563200, 'YYYY.MM.DD') 得到 '2023.02.17'\nDATETOSTR(1676563200000, 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'\nDATETOSTR(DATE('2021-12-21'), 'YYYY.MM.DD hh:mm:ss') 得到 '2021.12.21 08:00:00'",
         example: "DATETOSTR(date, 'YYYY-MM-DD')",
         params: [
             {
-                type: "date",
+                type: "any",
                 name: "date",
-                description: "日期对象"
+                description: "日期对象、日期字符串、时间戳"
             },
             {
                 type: "string",
@@ -1041,7 +1085,39 @@ var doc = [
             }
         ],
         returns: {
-            type: "number",
+            type: "string",
+            description: "日期字符串"
+        },
+        namespace: "日期函数"
+    },
+    {
+        name: "DATERANGESPLIT",
+        description: "获取日期范围字符串中的开始时间、结束时间\n\n示例：\n\nDATERANGESPLIT('1676563200, 1676735999') 得到 [1676563200, 1676735999]\nDATERANGESPLIT('1676563200, 1676735999', undefined , 'YYYY.MM.DD hh:mm:ss') 得到 [2023.02.17 12:00:00, 2023.02.18 11:59:59]\nDATERANGESPLIT('1676563200, 1676735999', 0 , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'\nDATERANGESPLIT('1676563200, 1676735999', 'start' , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.17 12:00:00'\nDATERANGESPLIT('1676563200, 1676735999', 1 , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.18 11:59:59'\nDATERANGESPLIT('1676563200, 1676735999', 'end' , 'YYYY.MM.DD hh:mm:ss') 得到 '2023.02.18 11:59:59'",
+        example: "DATERANGESPLIT(date, 'YYYY-MM-DD')",
+        params: [
+            {
+                type: "string",
+                name: "date",
+                description: "日期范围字符串"
+            },
+            {
+                type: "string",
+                name: "key",
+                description: "取值标识，0或'start'表示获取开始时间，1或'end'表示获取结束时间"
+            },
+            {
+                type: "string",
+                name: "format",
+                description: "日期格式，可选"
+            },
+            {
+                type: "string",
+                name: "delimiter",
+                description: "分隔符，可选，默认为','"
+            }
+        ],
+        returns: {
+            type: "string",
             description: "日期字符串"
         },
         namespace: "日期函数"
@@ -1060,6 +1136,11 @@ var doc = [
                 type: "string",
                 name: "unit",
                 description: "比如可以传入 'day'、'month'、'year' 或者 `week` 等等"
+            },
+            {
+                type: "string",
+                name: "format",
+                description: "日期格式，可选"
             }
         ],
         returns: {
@@ -1082,6 +1163,11 @@ var doc = [
                 type: "string",
                 name: "unit",
                 description: "比如可以传入 'day'、'month'、'year' 或者 `week` 等等"
+            },
+            {
+                type: "string",
+                name: "format",
+                description: "日期格式，可选"
             }
         ],
         returns: {
@@ -1383,6 +1469,38 @@ var doc = [
         },
         namespace: "日期函数"
     },
+    {
+        name: "BETWEENRANGE",
+        description: "判断日期是否在指定范围内\n\n示例：BETWEENRANGE('2021/12/6', ['2021/12/5','2021/12/7'])",
+        example: "BETWEENRANGE(date, [start, end])",
+        params: [
+            {
+                type: "any",
+                name: "date",
+                description: "第一个日期"
+            },
+            {
+                type: "Array<any>",
+                name: "daterange",
+                description: "日期范围"
+            },
+            {
+                type: "string",
+                name: "unit",
+                description: "单位，默认是 'day'， 即之比较到天"
+            },
+            {
+                type: "string",
+                name: "inclusivity",
+                description: "包容性规则，默认为'[]'。[ 表示包含、( 表示排除，如果使用包容性参数，则必须传入两个指示符，如'()'表示左右范围都排除"
+            }
+        ],
+        returns: {
+            type: "boolean",
+            description: "判断结果"
+        },
+        namespace: "日期函数"
+    },
     {
         name: "ISSAMEORBEFORE",
         description: "判断两个日期，是否第一个日期在第二个日期的前面或者相等",
@@ -1498,6 +1616,116 @@ var doc = [
         },
         namespace: "数组"
     },
+    {
+        name: "ARRAYFINDINDEX",
+        description: "数据做数据查找，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。\n找出第二个箭头函数返回为 true 的成员的索引。\n\n示例：\n\nARRAYFINDINDEX([0, 2, false], item => item === 2) 得到 1",
+        example: "ARRAYFINDINDEX(arr, item => item === 2)",
+        params: [
+            {
+                type: "Array<any>",
+                name: "arr",
+                description: "数组"
+            },
+            {
+                type: "Array<any>",
+                name: "iterator",
+                description: "箭头函数"
+            }
+        ],
+        returns: {
+            type: "number",
+            description: "结果"
+        },
+        namespace: "数组"
+    },
+    {
+        name: "ARRAYFIND",
+        description: "数据做数据查找，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。\n找出第二个箭头函数返回为 true 的成员。\n\n示例：\n\nARRAYFIND([0, 2, false], item => item === 2) 得到 2",
+        example: "ARRAYFIND(arr, item => item === 2)",
+        params: [
+            {
+                type: "Array<any>",
+                name: "arr",
+                description: "数组"
+            },
+            {
+                type: "Array<any>",
+                name: "iterator",
+                description: "箭头函数"
+            }
+        ],
+        returns: {
+            type: "any",
+            description: "结果"
+        },
+        namespace: "数组"
+    },
+    {
+        name: "ARRAYSOME",
+        description: "数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。\n判断第二个箭头函数是否存在返回为 true 的成员。\n\n示例：\n\nARRAYSOME([0, 2, false], item => item === 2) 得到 true",
+        example: "ARRAYSOME(arr, item => item === 2)",
+        params: [
+            {
+                type: "Array<any>",
+                name: "arr",
+                description: "数组"
+            },
+            {
+                type: "Array<any>",
+                name: "iterator",
+                description: "箭头函数"
+            }
+        ],
+        returns: {
+            type: "boolean",
+            description: "结果"
+        },
+        namespace: "数组"
+    },
+    {
+        name: "ARRAYEVERY",
+        description: "数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。\n判断第二个箭头函数返回是否都为 true。\n\n示例：\n\nARRAYEVERY([0, 2, false], item => item === 2) 得到 false",
+        example: "ARRAYEVERY(arr, item => item === 2)",
+        params: [
+            {
+                type: "Array<any>",
+                name: "arr",
+                description: "数组"
+            },
+            {
+                type: "Array<any>",
+                name: "iterator",
+                description: "箭头函数"
+            }
+        ],
+        returns: {
+            type: "boolean",
+            description: "结果"
+        },
+        namespace: "数组"
+    },
+    {
+        name: "ARRAYINCLUDES",
+        description: "判断数据中是否存在指定元素\n\n示例：\n\nARRAYINCLUDES([0, 2, false], 2) 得到 true",
+        example: "ARRAYINCLUDES(arr, 2)",
+        params: [
+            {
+                type: "Array<any>",
+                name: "arr",
+                description: "数组"
+            },
+            {
+                type: "any",
+                name: "item",
+                description: "元素"
+            }
+        ],
+        returns: {
+            type: "any",
+            description: "结果"
+        },
+        namespace: "数组"
+    },
     {
         name: "COMPACT",
         description: "数组过滤掉 false、null、0 和 \"\"\n\n示例：\n\nCOMPACT([0, 1, false, 2, '', 3]) 得到 [1, 2, 3]",
@@ -1576,6 +1804,67 @@ var doc = [
         },
         namespace: "数组"
     },
+    {
+        name: "ENCODEJSON",
+        description: "将JS对象转换成JSON字符串\n\n示例：\n\nENCODEJSON({name: 'amis'}) 得到 '{\"name\":\"amis\"}'",
+        example: "ENCODEJSON({name: 'amis'})",
+        params: [
+            {
+                type: "object",
+                name: "obj",
+                description: "JS对象"
+            }
+        ],
+        returns: {
+            type: "string",
+            description: "结果"
+        },
+        namespace: "编码"
+    },
+    {
+        name: "DECODEJSON",
+        description: "解析JSON编码数据，返回JS对象\n\n示例：\n\nDECODEJSON('{\\\"name\\\": \"amis\"}') 得到 {name: 'amis'}",
+        example: "DECODEJSON('{\\\"name\\\": \"amis\"}')",
+        params: [
+            {
+                type: "string",
+                name: "str",
+                description: "字符串"
+            }
+        ],
+        returns: {
+            type: "object",
+            description: "结果"
+        },
+        namespace: "编码"
+    },
+    {
+        name: "GET",
+        description: "根据对象或者数组的path路径获取值。 如果解析 value 是 undefined 会以 defaultValue 取代\n\n示例：\n\nGET([0, 2, {name: 'amis', age: 18}], 1) 得到 2\nGET([0, 2, {name: 'amis', age: 18}], '2.name') 得到 'amis'\nGET({arr: [{name: 'amis', age: 18}]}, 'arr[0].name') 得到 'amis'\nGET({arr: [{name: 'amis', age: 18}]}, 'arr.0.name') 得到 'amis'\nGET({arr: [{name: 'amis', age: 18}]}, 'arr.1.name', 'not-found') 得到 'not-found'",
+        example: "GET(arr, 2)",
+        params: [
+            {
+                type: "any",
+                name: "obj",
+                description: "对象或数组"
+            },
+            {
+                type: "string",
+                name: "path",
+                description: "路径"
+            },
+            {
+                type: "any",
+                name: "defaultValue",
+                description: "如果解析不到则返回该值"
+            }
+        ],
+        returns: {
+            type: "any",
+            description: "结果"
+        },
+        namespace: "其他"
+    },
     {
         name: "ISTYPE",
         description: "判断是否为类型支持：string, number, array, date, plain-object。",
@@ -1589,7 +1878,7 @@ var doc = [
         ],
         returns: {
             type: "boolean",
-            description: "结果结果"
+            description: "结果"
         },
         namespace: "其他"
     }

package/lib/doc.md

@@ -612,16 +612,75 @@
 
 返回现在的日期
 
+### WEEKDAY
+
+用法：`WEEKDAY(date)`
+
+ * `date:any` 日期
+ * `type:number` 星期定义类型，默认为1，1表示0至6代表星期一到星期日，2表示1至7代表星期一到星期日
+
+返回：`number` 星期几的数字标识
+
+获取日期的星期几，
+
+示例：
+
+WEEKDAY('2023-02-27') 得到 1
+
+### WEEK
+
+用法：`WEEK(date)`
+
+ * `date:any` 日期
+ * `isISO:boolean` 是否ISO星期
+
+返回：`number` 星期几的数字标识
+
+获取年份的星期，即第几周
+
+示例：
+
+WEEK('2023-03-05') 得到 10
+
 ### DATETOSTR
 
 用法：`DATETOSTR(date, 'YYYY-MM-DD')`
 
- * `date:date` 日期对象
+ * `date:any` 日期对象、日期字符串、时间戳
  * `format:string` 日期格式，默认为 "YYYY-MM-DD HH:mm:ss"
 
-返回：`number` 日期字符串
+返回：`string` 日期字符串
+
+对日期、日期字符串、时间戳进行格式化
+
+示例：
+
+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'
+
+### DATERANGESPLIT
 
-将日期转成日期字符串
+用法：`DATERANGESPLIT(date, 'YYYY-MM-DD')`
+
+ * `date:string` 日期范围字符串
+ * `key:string` 取值标识，0或'start'表示获取开始时间，1或'end'表示获取结束时间
+ * `format:string` 日期格式，可选
+ * `delimiter: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'
 
 ### STARTOF
 
@@ -629,6 +688,7 @@
 
  * `date:date` 日期对象
  * `unit:string` 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
+ * `format:string` 日期格式，可选
 
 返回：`date` 新的日期对象
 
@@ -640,6 +700,7 @@
 
  * `date:date` 日期对象
  * `unit:string` 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
+ * `format:string` 日期格式，可选
 
 返回：`date` 新的日期对象
 
@@ -804,6 +865,21 @@ DATEMODIFY(A, -2, 'month')
 
 判断两个日期，是否第一个日期在第二个日期的后面
 
+### BETWEENRANGE
+
+用法：`BETWEENRANGE(date, [start, end])`
+
+ * `date:any` 第一个日期
+ * `daterange:Array<any>` 日期范围
+ * `unit:string` 单位，默认是 'day'， 即之比较到天
+ * `inclusivity:string` 包容性规则，默认为'[]'。[ 表示包含、( 表示排除，如果使用包容性参数，则必须传入两个指示符，如'()'表示左右范围都排除
+
+返回：`boolean` 判断结果
+
+判断日期是否在指定范围内
+
+示例：BETWEENRANGE('2021/12/6', ['2021/12/5','2021/12/7'])
+
 ### ISSAMEORBEFORE
 
 用法：`ISSAMEORBEFORE(a, b)`
@@ -863,6 +939,85 @@ DATEMODIFY(A, -2, 'month')
 数据做数据过滤，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
 将第二个箭头函数返回为 false 的成员过滤掉。
 
+### ARRAYFINDINDEX
+
+用法：`ARRAYFINDINDEX(arr, item => item === 2)`
+
+ * `arr:Array<any>` 数组
+ * `iterator:Array<any>` 箭头函数
+
+返回：`number` 结果
+
+数据做数据查找，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+找出第二个箭头函数返回为 true 的成员的索引。
+
+示例：
+
+ARRAYFINDINDEX([0, 2, false], item => item === 2) 得到 1
+
+### ARRAYFIND
+
+用法：`ARRAYFIND(arr, item => item === 2)`
+
+ * `arr:Array<any>` 数组
+ * `iterator:Array<any>` 箭头函数
+
+返回：`any` 结果
+
+数据做数据查找，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+找出第二个箭头函数返回为 true 的成员。
+
+示例：
+
+ARRAYFIND([0, 2, false], item => item === 2) 得到 2
+
+### ARRAYSOME
+
+用法：`ARRAYSOME(arr, item => item === 2)`
+
+ * `arr:Array<any>` 数组
+ * `iterator:Array<any>` 箭头函数
+
+返回：`boolean` 结果
+
+数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+判断第二个箭头函数是否存在返回为 true 的成员。
+
+示例：
+
+ARRAYSOME([0, 2, false], item => item === 2) 得到 true
+
+### ARRAYEVERY
+
+用法：`ARRAYEVERY(arr, item => item === 2)`
+
+ * `arr:Array<any>` 数组
+ * `iterator:Array<any>` 箭头函数
+
+返回：`boolean` 结果
+
+数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+判断第二个箭头函数返回是否都为 true。
+
+示例：
+
+ARRAYEVERY([0, 2, false], item => item === 2) 得到 false
+
+### ARRAYINCLUDES
+
+用法：`ARRAYINCLUDES(arr, 2)`
+
+ * `arr:Array<any>` 数组
+ * `item:any` 元素
+
+返回：`any` 结果
+
+判断数据中是否存在指定元素
+
+示例：
+
+ARRAYINCLUDES([0, 2, false], 2) 得到 true
+
 ### COMPACT
 
 用法：`COMPACT(arr)`
@@ -921,15 +1076,65 @@ CONCAT(['a', 'b', 'c'], ['1'], ['3']) 得到 ['a', 'b', 'c', '1', '3']
 
 UNIQ([{a: '1'}, {b: '2'}, {a: '1'}]， 'id')
 
+## 编码
+
+### ENCODEJSON
+
+用法：`ENCODEJSON({name: 'amis'})`
+
+ * `obj:object` JS对象
+
+返回：`string` 结果
+
+将JS对象转换成JSON字符串
+
+示例：
+
+ENCODEJSON({name: 'amis'}) 得到 '{"name":"amis"}'
+
+### DECODEJSON
+
+用法：`DECODEJSON('{\"name\": "amis"}')`
+
+ * `str:string` 字符串
+
+返回：`object` 结果
+
+解析JSON编码数据，返回JS对象
+
+示例：
+
+DECODEJSON('{\"name\": "amis"}') 得到 {name: 'amis'}
+
 ## 其他
 
+### GET
+
+用法：`GET(arr, 2)`
+
+ * `obj:any` 对象或数组
+ * `path:string` 路径
+ * `defaultValue:any` 如果解析不到则返回该值
+
+返回：`any` 结果
+
+根据对象或者数组的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'
+
 ### ISTYPE
 
 用法：`ISTYPE([{a: '1'}, {b: '2'}, {a: '1'}], 'array')`
 
  * `判断对象:string` null
 
-返回：`boolean` 结果结果
+返回：`boolean` 结果
 
 判断是否为类型支持：string, number, array, date, plain-object。