amis-formula 3.1.0 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/esm/doc.js CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * amis-formula v3.1.0
2
+ * amis-formula v3.2.0
3
3
  * Copyright 2021-2023 fex
4
4
  */
5
5
 
@@ -9,13 +9,13 @@
9
9
  var doc = [
10
10
  {
11
11
  name: "IF",
12
- description: "示例:IF(A, B, C)\n\n如果满足条件A,则返回B,否则返回C,支持多层嵌套IF函数。\n\n也可以用表达式如:A ? B : C",
12
+ description: "如果满足条件condition,则返回consequent,否则返回alternate,支持多层嵌套IF函数。\n\n等价于直接用JS表达式如:condition ? consequent : alternate。",
13
13
  example: "IF(condition, consequent, alternate)",
14
14
  params: [
15
15
  {
16
16
  type: "expression",
17
17
  name: "condition",
18
- description: "条件表达式."
18
+ description: "条件表达式。例如:语文成绩>80"
19
19
  },
20
20
  {
21
21
  type: "any",
@@ -36,13 +36,13 @@ var doc = [
36
36
  },
37
37
  {
38
38
  name: "AND",
39
- description: "条件全部符合,返回 true,否则返回 false\n\n示例:AND(语文成绩>80, 数学成绩>80)\n\n语文成绩和数学成绩都大于 80,则返回 true,否则返回 false\n\n也可以直接用表达式如:语文成绩>80 && 数学成绩>80",
39
+ description: "条件全部符合,返回 true,否则返回 false。\n\n示例:AND(语文成绩>80, 数学成绩>80),\n\n语文成绩和数学成绩都大于 80,则返回 true,否则返回 false,\n\n等价于直接用JS表达式如:语文成绩>80 && 数学成绩>80",
40
40
  example: "AND(expression1, expression2, ...expressionN)",
41
41
  params: [
42
42
  {
43
43
  type: "...expression",
44
44
  name: "conditions",
45
- description: "条件表达式."
45
+ description: "条件表达式,多个用逗号隔开。例如:语文成绩>80, 数学成绩>80"
46
46
  }
47
47
  ],
48
48
  returns: {
@@ -53,13 +53,13 @@ var doc = [
53
53
  },
54
54
  {
55
55
  name: "OR",
56
- description: "条件任意一个满足条件,返回 true,否则返回 false\n\n示例:OR(语文成绩>80, 数学成绩>80)\n\n语文成绩和数学成绩任意一个大于 80,则返回 true,否则返回 false\n\n也可以直接用表达式如:语文成绩>80 || 数学成绩>80",
56
+ description: "条件任意一个满足条件,返回 true,否则返回 false。\n\n示例:OR(语文成绩>80, 数学成绩>80),\n\n语文成绩和数学成绩任意一个大于 80,则返回 true,否则返回 false,\n\n等价于直接用JS表达式如:语文成绩>80 || 数学成绩>80",
57
57
  example: "OR(expression1, expression2, ...expressionN)",
58
58
  params: [
59
59
  {
60
60
  type: "...expression",
61
61
  name: "conditions",
62
- description: "条件表达式."
62
+ description: "条件表达式,多个用逗号隔开。例如:语文成绩>80, 数学成绩>80"
63
63
  }
64
64
  ],
65
65
  returns: {
@@ -70,18 +70,13 @@ var doc = [
70
70
  },
71
71
  {
72
72
  name: "XOR",
73
- description: "异或处理,多个表达式组中存在奇数个真时认为真。",
74
- example: "XOR(condition1, condition2)",
73
+ description: "异或处理,多个表达式组中存在奇数个真时认为真。\n\n示例:XOR(语文成绩 > 80, 数学成绩 > 80, 英语成绩 > 80)\n\n三门成绩中有一门或者三门大于 80,则返回 true,否则返回 false。",
74
+ example: "XOR(condition1, condition2, ...expressionN)",
75
75
  params: [
76
76
  {
77
- type: "expression",
78
- name: "condition1",
79
- description: "条件表达式1"
80
- },
81
- {
82
- type: "expression",
83
- name: "condition2",
84
- description: "条件表达式2"
77
+ type: "...expression",
78
+ name: "condition",
79
+ description: "条件表达式,多个用逗号隔开。例如:语文成绩>80, 数学成绩>80"
85
80
  }
86
81
  ],
87
82
  returns: {
@@ -92,13 +87,18 @@ var doc = [
92
87
  },
93
88
  {
94
89
  name: "IFS",
95
- description: "判断函数集合,相当于多个 else if 合并成一个。\n\n示例:IFS(语文成绩 > 80, \"优秀\", 语文成绩 > 60, \"良\", \"继续努力\")\n\n如果语文成绩大于 80,则返回优秀,否则判断大于 60 分,则返回良,否则返回继续努力。",
90
+ description: "判断函数集合,相当于多个 else if 合并成一个。\n\n示例:IFS(语文成绩 > 80, \"优秀\", 语文成绩 > 60, \"良\", \"继续努力\"),\n\n如果语文成绩大于 80,则返回优秀,否则判断大于 60 分,则返回良,否则返回继续努力。",
96
91
  example: "IFS(condition1, result1, condition2, result2,...conditionN, resultN)",
97
92
  params: [
93
+ {
94
+ type: "...expression",
95
+ name: "condition",
96
+ description: "条件表达式"
97
+ },
98
98
  {
99
99
  type: "...any",
100
- name: "args",
101
- description: "条件,返回值集合"
100
+ name: "result",
101
+ description: "返回值"
102
102
  }
103
103
  ],
104
104
  returns: {
@@ -109,7 +109,7 @@ var doc = [
109
109
  },
110
110
  {
111
111
  name: "ABS",
112
- description: "返回传入数字的绝对值",
112
+ description: "返回传入数字的绝对值。",
113
113
  example: "ABS(num)",
114
114
  params: [
115
115
  {
@@ -126,7 +126,7 @@ var doc = [
126
126
  },
127
127
  {
128
128
  name: "MAX",
129
- description: "获取最大值,如果只有一个参数且是数组,则计算这个数组内的值",
129
+ description: "获取最大值,如果只有一个参数且是数组,则计算这个数组内的值。",
130
130
  example: "MAX(num1, num2, ...numN)",
131
131
  params: [
132
132
  {
@@ -143,7 +143,7 @@ var doc = [
143
143
  },
144
144
  {
145
145
  name: "MIN",
146
- description: "获取最小值,如果只有一个参数且是数组,则计算这个数组内的值",
146
+ description: "获取最小值,如果只有一个参数且是数组,则计算这个数组内的值。",
147
147
  example: "MIN(num1, num2, ...numN)",
148
148
  params: [
149
149
  {
@@ -160,7 +160,7 @@ var doc = [
160
160
  },
161
161
  {
162
162
  name: "SUM",
163
- description: "求和,如果只有一个参数且是数组,则计算这个数组内的值",
163
+ description: "求和,如果只有一个参数且是数组,则计算这个数组内的值。",
164
164
  example: "SUM(num1, num2, ...numN)",
165
165
  params: [
166
166
  {
@@ -177,7 +177,7 @@ var doc = [
177
177
  },
178
178
  {
179
179
  name: "INT",
180
- description: "将数值向下取整为最接近的整数",
180
+ description: "将数值向下取整为最接近的整数。",
181
181
  example: "INT(num)",
182
182
  params: [
183
183
  {
@@ -194,7 +194,7 @@ var doc = [
194
194
  },
195
195
  {
196
196
  name: "MOD",
197
- description: "返回两数相除的余数,参数 number 是被除数,divisor 是除数",
197
+ description: "返回两数相除的余数,参数 number 是被除数,divisor 是除数。",
198
198
  example: "MOD(num, divisor)",
199
199
  params: [
200
200
  {
@@ -216,7 +216,7 @@ var doc = [
216
216
  },
217
217
  {
218
218
  name: "PI",
219
- description: "圆周率 3.1415...",
219
+ description: "圆周率 3.1415...。",
220
220
  example: "PI()",
221
221
  params: [],
222
222
  returns: {
@@ -238,7 +238,7 @@ var doc = [
238
238
  {
239
239
  type: "number",
240
240
  name: "numDigits",
241
- description: "小数位数"
241
+ description: "小数位数,默认为2"
242
242
  }
243
243
  ],
244
244
  returns: {
@@ -260,7 +260,7 @@ var doc = [
260
260
  {
261
261
  type: "number",
262
262
  name: "numDigits",
263
- description: "小数位数"
263
+ description: "小数位数,默认为2"
264
264
  }
265
265
  ],
266
266
  returns: {
@@ -282,7 +282,7 @@ var doc = [
282
282
  {
283
283
  type: "number",
284
284
  name: "numDigits",
285
- description: "小数位数"
285
+ description: "小数位数,默认为2"
286
286
  }
287
287
  ],
288
288
  returns: {
@@ -310,7 +310,7 @@ var doc = [
310
310
  },
311
311
  {
312
312
  name: "AVG",
313
- description: "返回所有参数的平均值,如果只有一个参数且是数组,则计算这个数组内的值",
313
+ description: "返回所有参数的平均值,如果只有一个参数且是数组,则计算这个数组内的值。",
314
314
  example: "AVG(num1, num2, ...numN)",
315
315
  params: [
316
316
  {
@@ -327,7 +327,7 @@ var doc = [
327
327
  },
328
328
  {
329
329
  name: "DEVSQ",
330
- description: "返回数据点与数据均值点之差(数据偏差)的平方和,如果只有一个参数且是数组,则计算这个数组内的值",
330
+ description: "返回数据点与数据均值点之差(数据偏差)的平方和,如果只有一个参数且是数组,则计算这个数组内的值。",
331
331
  example: "DEVSQ(num1, num2, ...numN)",
332
332
  params: [
333
333
  {
@@ -344,7 +344,7 @@ var doc = [
344
344
  },
345
345
  {
346
346
  name: "AVEDEV",
347
- description: "数据点到其算术平均值的绝对偏差的平均值",
347
+ description: "数据点到其算术平均值的绝对偏差的平均值。",
348
348
  example: "AVEDEV(num1, num2, ...numN)",
349
349
  params: [
350
350
  {
@@ -361,7 +361,7 @@ var doc = [
361
361
  },
362
362
  {
363
363
  name: "HARMEAN",
364
- description: "数据点的调和平均值,如果只有一个参数且是数组,则计算这个数组内的值",
364
+ description: "数据点的调和平均值,如果只有一个参数且是数组,则计算这个数组内的值。",
365
365
  example: "HARMEAN(num1, num2, ...numN)",
366
366
  params: [
367
367
  {
@@ -378,7 +378,7 @@ var doc = [
378
378
  },
379
379
  {
380
380
  name: "LARGE",
381
- description: "数据集中第 k 个最大值",
381
+ description: "数据集中第 k 个最大值。",
382
382
  example: "LARGE(array, k)",
383
383
  params: [
384
384
  {
@@ -400,7 +400,7 @@ var doc = [
400
400
  },
401
401
  {
402
402
  name: "UPPERMONEY",
403
- description: "将数值转为中文大写金额",
403
+ description: "将数值转为中文大写金额。",
404
404
  example: "UPPERMONEY(num)",
405
405
  params: [
406
406
  {
@@ -417,7 +417,7 @@ var doc = [
417
417
  },
418
418
  {
419
419
  name: "RAND",
420
- description: "返回大于等于 0 且小于 1 的均匀分布随机实数。每一次触发计算都会变化。\n\n示例:`RAND()*100`\n\n返回 0-100 之间的随机数",
420
+ description: "返回大于等于 0 且小于 1 的均匀分布随机实数。每一次触发计算都会变化。\n\n示例:`RAND()*100`,\n\n返回 0-100 之间的随机数。",
421
421
  example: "RAND()",
422
422
  params: [],
423
423
  returns: {
@@ -428,7 +428,7 @@ var doc = [
428
428
  },
429
429
  {
430
430
  name: "LAST",
431
- description: "取数据最后一个",
431
+ description: "取数据最后一个。",
432
432
  example: "LAST(array)",
433
433
  params: [
434
434
  {
@@ -489,7 +489,7 @@ var doc = [
489
489
  },
490
490
  {
491
491
  name: "LEN",
492
- description: "计算文本的长度",
492
+ description: "计算文本的长度。",
493
493
  example: "LEN(text)",
494
494
  params: [
495
495
  {
@@ -506,7 +506,7 @@ var doc = [
506
506
  },
507
507
  {
508
508
  name: "LENGTH",
509
- description: "计算文本集合中所有文本的长度",
509
+ description: "计算文本集合中所有文本的长度。",
510
510
  example: "LENGTH(textArr)",
511
511
  params: [
512
512
  {
@@ -523,7 +523,7 @@ var doc = [
523
523
  },
524
524
  {
525
525
  name: "ISEMPTY",
526
- description: "判断文本是否为空",
526
+ description: "判断文本是否为空。",
527
527
  example: "ISEMPTY(text)",
528
528
  params: [
529
529
  {
@@ -540,7 +540,7 @@ var doc = [
540
540
  },
541
541
  {
542
542
  name: "CONCATENATE",
543
- description: "将多个传入值连接成文本",
543
+ description: "将多个传入值连接成文本。",
544
544
  example: "CONCATENATE(text1, text2, ...textN)",
545
545
  params: [
546
546
  {
@@ -557,7 +557,7 @@ var doc = [
557
557
  },
558
558
  {
559
559
  name: "CHAR",
560
- description: "返回计算机字符集的数字代码所对应的字符。\n\n`CHAR(97)` 等价于 \"a\"",
560
+ description: "返回计算机字符集的数字代码所对应的字符。\n\n示例:`CHAR(97)` 等价于 \"a\"",
561
561
  example: "CHAR(code)",
562
562
  params: [
563
563
  {
@@ -574,7 +574,7 @@ var doc = [
574
574
  },
575
575
  {
576
576
  name: "LOWER",
577
- description: "将传入文本转成小写",
577
+ description: "将传入文本转成小写。",
578
578
  example: "LOWER(text)",
579
579
  params: [
580
580
  {
@@ -591,7 +591,7 @@ var doc = [
591
591
  },
592
592
  {
593
593
  name: "UPPER",
594
- description: "将传入文本转成大写",
594
+ description: "将传入文本转成大写。",
595
595
  example: "UPPER(text)",
596
596
  params: [
597
597
  {
@@ -608,7 +608,7 @@ var doc = [
608
608
  },
609
609
  {
610
610
  name: "UPPERFIRST",
611
- description: "将传入文本首字母转成大写",
611
+ description: "将传入文本首字母转成大写。",
612
612
  example: "UPPERFIRST(text)",
613
613
  params: [
614
614
  {
@@ -625,7 +625,7 @@ var doc = [
625
625
  },
626
626
  {
627
627
  name: "PADSTART",
628
- description: "向前补齐文本长度\n\n示例 `PADSTART(\"6\", 2, \"0\")`\n\n返回 `06`",
628
+ description: "向前补齐文本长度。\n\n示例 `PADSTART(\"6\", 2, \"0\")`,\n\n返回 `06`。",
629
629
  example: "PADSTART(text)",
630
630
  params: [
631
631
  {
@@ -652,7 +652,7 @@ var doc = [
652
652
  },
653
653
  {
654
654
  name: "CAPITALIZE",
655
- description: "将文本转成标题\n\n示例 `CAPITALIZE(\"star\")`\n\n返回 `Star`",
655
+ description: "将文本转成标题。\n\n示例 `CAPITALIZE(\"star\")`,\n\n返回 `Star`。",
656
656
  example: "CAPITALIZE(text)",
657
657
  params: [
658
658
  {
@@ -669,7 +669,7 @@ var doc = [
669
669
  },
670
670
  {
671
671
  name: "ESCAPE",
672
- description: "对文本进行 HTML 转义\n\n示例 `ESCAPE(\"<star>&\")`\n\n返回 `&lt;start&gt;&amp;`",
672
+ description: "对文本进行 HTML 转义。\n\n示例 `ESCAPE(\"<star>&\")`,\n\n返回 `&lt;start&gt;&amp;`。",
673
673
  example: "ESCAPE(text)",
674
674
  params: [
675
675
  {
@@ -686,7 +686,7 @@ var doc = [
686
686
  },
687
687
  {
688
688
  name: "TRUNCATE",
689
- description: "对文本长度进行截断\n\n示例 `TRUNCATE(\"amis.baidu.com\", 6)`\n\n返回 `amis...`",
689
+ description: "对文本长度进行截断。\n\n示例 `TRUNCATE(\"amis.baidu.com\", 6)`,\n\n返回 `amis...`。",
690
690
  example: "TRUNCATE(text, 6)",
691
691
  params: [
692
692
  {
@@ -708,7 +708,7 @@ var doc = [
708
708
  },
709
709
  {
710
710
  name: "BEFORELAST",
711
- description: "取在某个分隔符之前的所有字符串",
711
+ description: "取在某个分隔符之前的所有字符串。",
712
712
  example: "BEFORELAST(text, '.')",
713
713
  params: [
714
714
  {
@@ -730,7 +730,7 @@ var doc = [
730
730
  },
731
731
  {
732
732
  name: "SPLIT",
733
- description: "将文本根据指定片段分割成数组\n\n示例:`SPLIT(\"a,b,c\", \",\")`\n\n返回 `[\"a\", \"b\", \"c\"]`",
733
+ description: "将文本根据指定片段分割成数组。\n\n示例:`SPLIT(\"a,b,c\", \",\")`,\n\n返回 `[\"a\", \"b\", \"c\"]`。",
734
734
  example: "SPLIT(text, ',')",
735
735
  params: [
736
736
  {
@@ -752,7 +752,7 @@ var doc = [
752
752
  },
753
753
  {
754
754
  name: "TRIM",
755
- description: "将文本去除前后空格",
755
+ description: "将文本去除前后空格。",
756
756
  example: "TRIM(text)",
757
757
  params: [
758
758
  {
@@ -769,7 +769,7 @@ var doc = [
769
769
  },
770
770
  {
771
771
  name: "STRIPTAG",
772
- description: "去除文本中的 HTML 标签\n\n示例:`STRIPTAG(\"<b>amis</b>\")`\n\n返回:`amis`",
772
+ description: "去除文本中的 HTML 标签。\n\n示例:`STRIPTAG(\"<b>amis</b>\")`,\n\n返回:`amis`。",
773
773
  example: "STRIPTAG(text)",
774
774
  params: [
775
775
  {
@@ -786,7 +786,7 @@ var doc = [
786
786
  },
787
787
  {
788
788
  name: "LINEBREAK",
789
- description: "将字符串中的换行转成 HTML `<br>`,用于简单换行的场景\n\n示例:`LINEBREAK(\"\\n\")`\n\n返回:`<br/>`",
789
+ description: "将字符串中的换行转成 HTML `<br>`,用于简单换行的场景。\n\n示例:`LINEBREAK(\"\\n\")`,\n\n返回:`<br/>`。",
790
790
  example: "LINEBREAK(text)",
791
791
  params: [
792
792
  {
@@ -803,7 +803,7 @@ var doc = [
803
803
  },
804
804
  {
805
805
  name: "STARTSWITH",
806
- description: "判断字符串(text)是否以特定字符串(startString)开始,是则返回 True,否则返回 False",
806
+ description: "判断字符串(text)是否以特定字符串(startString)开始,是则返回 true,否则返回 false。",
807
807
  example: "STARTSWITH(text, '片段')",
808
808
  params: [
809
809
  {
@@ -825,7 +825,7 @@ var doc = [
825
825
  },
826
826
  {
827
827
  name: "ENDSWITH",
828
- description: "判断字符串(text)是否以特定字符串(endString)结束,是则返回 True,否则返回 False",
828
+ description: "判断字符串(text)是否以特定字符串(endString)结束,是则返回 true,否则返回 false。",
829
829
  example: "ENDSWITH(text, '片段')",
830
830
  params: [
831
831
  {
@@ -847,7 +847,7 @@ var doc = [
847
847
  },
848
848
  {
849
849
  name: "CONTAINS",
850
- description: "判断参数 1 中的文本是否包含参数 2 中的文本。",
850
+ description: "判断参数 1 中的文本是否包含参数 2 中的文本,是则返回 true,否则返回 false。",
851
851
  example: "CONTAINS(text, searchText)",
852
852
  params: [
853
853
  {
@@ -896,7 +896,7 @@ var doc = [
896
896
  },
897
897
  {
898
898
  name: "SEARCH",
899
- description: "对文本进行搜索,返回命中的位置",
899
+ description: "对文本进行搜索,返回命中的位置。",
900
900
  example: "SEARCH(text, search, 0)",
901
901
  params: [
902
902
  {
@@ -923,7 +923,7 @@ var doc = [
923
923
  },
924
924
  {
925
925
  name: "MID",
926
- description: "返回文本字符串中从指定位置开始的特定数目的字符",
926
+ description: "返回文本字符串中从指定位置开始的特定数目的字符。",
927
927
  example: "MID(text, from, len)",
928
928
  params: [
929
929
  {
@@ -950,7 +950,7 @@ var doc = [
950
950
  },
951
951
  {
952
952
  name: "BASENAME",
953
- description: "返回路径中的文件名\n\n示例:`/home/amis/a.json`\n\n返回:a.json`",
953
+ description: "返回路径中的文件名。\n\n示例:`/home/amis/a.json`,\n\n返回:a.json`。",
954
954
  example: "BASENAME(text)",
955
955
  params: [
956
956
  {
@@ -967,7 +967,7 @@ var doc = [
967
967
  },
968
968
  {
969
969
  name: "DATE",
970
- description: "创建日期对象,可以通过特定格式的字符串,或者数值。\n\n需要注意的是,其中月份的数值是从0开始的,也就是说,\n如果是12月份,你应该传入数值11。",
970
+ description: "创建日期对象,可以通过特定格式的字符串,或者数值。\n\n需要注意的是,其中月份的数值是从0开始的,\n即如果是12月份,你应该传入数值11。",
971
971
  example: "DATE('2021-12-06 08:20:00')",
972
972
  params: [],
973
973
  returns: {
@@ -978,8 +978,8 @@ var doc = [
978
978
  },
979
979
  {
980
980
  name: "TIMESTAMP",
981
- description: "返回时间的时间戳",
982
- example: "TIMESTAMP(date, 'x')",
981
+ description: "返回时间的时间戳。",
982
+ example: "TIMESTAMP(date[, format = \"X\"])",
983
983
  params: [
984
984
  {
985
985
  type: "date",
@@ -1000,7 +1000,7 @@ var doc = [
1000
1000
  },
1001
1001
  {
1002
1002
  name: "TODAY",
1003
- description: "返回今天的日期",
1003
+ description: "返回今天的日期。",
1004
1004
  example: "TODAY()",
1005
1005
  params: [],
1006
1006
  returns: {
@@ -1022,7 +1022,7 @@ var doc = [
1022
1022
  },
1023
1023
  {
1024
1024
  name: "WEEKDAY",
1025
- description: "获取日期的星期几,\n\n示例:\n\nWEEKDAY('2023-02-27') 得到 1",
1025
+ description: "获取日期的星期几。\n\n示例\n\nWEEKDAY('2023-02-27') 得到 1",
1026
1026
  example: "WEEKDAY(date)",
1027
1027
  params: [
1028
1028
  {
@@ -1044,7 +1044,7 @@ var doc = [
1044
1044
  },
1045
1045
  {
1046
1046
  name: "WEEK",
1047
- description: "获取年份的星期,即第几周\n\n示例:\n\nWEEK('2023-03-05') 得到 10",
1047
+ description: "获取年份的星期,即第几周。\n\n示例\n\nWEEK('2023-03-05') 得到 10",
1048
1048
  example: "WEEK(date)",
1049
1049
  params: [
1050
1050
  {
@@ -1066,7 +1066,7 @@ var doc = [
1066
1066
  },
1067
1067
  {
1068
1068
  name: "DATETOSTR",
1069
- 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'",
1069
+ 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'",
1070
1070
  example: "DATETOSTR(date, 'YYYY-MM-DD')",
1071
1071
  params: [
1072
1072
  {
@@ -1088,7 +1088,7 @@ var doc = [
1088
1088
  },
1089
1089
  {
1090
1090
  name: "DATERANGESPLIT",
1091
- 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'",
1091
+ 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'",
1092
1092
  example: "DATERANGESPLIT(date, 'YYYY-MM-DD')",
1093
1093
  params: [
1094
1094
  {
@@ -1120,7 +1120,7 @@ var doc = [
1120
1120
  },
1121
1121
  {
1122
1122
  name: "STARTOF",
1123
- description: "返回日期的指定范围的开端",
1123
+ description: "返回日期的指定范围的开端。",
1124
1124
  example: "STARTOF(date[unit = \"day\"])",
1125
1125
  params: [
1126
1126
  {
@@ -1147,7 +1147,7 @@ var doc = [
1147
1147
  },
1148
1148
  {
1149
1149
  name: "ENDOF",
1150
- description: "返回日期的指定范围的末尾",
1150
+ description: "返回日期的指定范围的末尾。",
1151
1151
  example: "ENDOF(date[unit = \"day\"])",
1152
1152
  params: [
1153
1153
  {
@@ -1174,7 +1174,7 @@ var doc = [
1174
1174
  },
1175
1175
  {
1176
1176
  name: "YEAR",
1177
- description: "返回日期的年份",
1177
+ description: "返回日期的年份。",
1178
1178
  example: "YEAR(date)",
1179
1179
  params: [
1180
1180
  {
@@ -1208,7 +1208,7 @@ var doc = [
1208
1208
  },
1209
1209
  {
1210
1210
  name: "DAY",
1211
- description: "返回日期的天",
1211
+ description: "返回日期的天。",
1212
1212
  example: "DAY(date)",
1213
1213
  params: [
1214
1214
  {
@@ -1225,7 +1225,7 @@ var doc = [
1225
1225
  },
1226
1226
  {
1227
1227
  name: "HOUR",
1228
- description: "返回日期的小时",
1228
+ description: "返回日期的小时。",
1229
1229
  example: "HOUR(date)",
1230
1230
  params: [
1231
1231
  {
@@ -1242,7 +1242,7 @@ var doc = [
1242
1242
  },
1243
1243
  {
1244
1244
  name: "MINUTE",
1245
- description: "返回日期的分",
1245
+ description: "返回日期的分。",
1246
1246
  example: "MINUTE(date)",
1247
1247
  params: [
1248
1248
  {
@@ -1259,7 +1259,7 @@ var doc = [
1259
1259
  },
1260
1260
  {
1261
1261
  name: "SECOND",
1262
- description: "返回日期的秒",
1262
+ description: "返回日期的秒。",
1263
1263
  example: "SECOND(date)",
1264
1264
  params: [
1265
1265
  {
@@ -1276,7 +1276,7 @@ var doc = [
1276
1276
  },
1277
1277
  {
1278
1278
  name: "YEARS",
1279
- description: "返回两个日期相差多少年",
1279
+ description: "返回两个日期相差多少年。",
1280
1280
  example: "YEARS(endDate, startDate)",
1281
1281
  params: [
1282
1282
  {
@@ -1298,7 +1298,7 @@ var doc = [
1298
1298
  },
1299
1299
  {
1300
1300
  name: "MINUTES",
1301
- description: "返回两个日期相差多少分钟",
1301
+ description: "返回两个日期相差多少分钟。",
1302
1302
  example: "MINUTES(endDate, startDate)",
1303
1303
  params: [
1304
1304
  {
@@ -1320,7 +1320,7 @@ var doc = [
1320
1320
  },
1321
1321
  {
1322
1322
  name: "DAYS",
1323
- description: "返回两个日期相差多少天",
1323
+ description: "返回两个日期相差多少天。",
1324
1324
  example: "DAYS(endDate, startDate)",
1325
1325
  params: [
1326
1326
  {
@@ -1342,7 +1342,7 @@ var doc = [
1342
1342
  },
1343
1343
  {
1344
1344
  name: "HOURS",
1345
- description: "返回两个日期相差多少小时",
1345
+ description: "返回两个日期相差多少小时。",
1346
1346
  example: "HOURS(endDate, startDate)",
1347
1347
  params: [
1348
1348
  {
@@ -1364,7 +1364,7 @@ var doc = [
1364
1364
  },
1365
1365
  {
1366
1366
  name: "DATEMODIFY",
1367
- description: "修改日期,对日期进行加减天、月份、年等操作\n\n示例:\n\nDATEMODIFY(A, -2, 'month')\n\n对日期 A 进行往前减2月的操作。",
1367
+ description: "修改日期,对日期进行加减天、月份、年等操作。\n\n示例:\n\nDATEMODIFY(A, -2, 'month'),\n\n对日期 A 进行往前减2月的操作。",
1368
1368
  example: "DATEMODIFY(date, 2, 'days')",
1369
1369
  params: [
1370
1370
  {
@@ -1413,7 +1413,7 @@ var doc = [
1413
1413
  },
1414
1414
  {
1415
1415
  name: "ISBEFORE",
1416
- description: "判断两个日期,是否第一个日期在第二个日期的前面",
1416
+ description: "判断两个日期,是否第一个日期在第二个日期的前面,是则返回 true,否则返回 false。",
1417
1417
  example: "ISBEFORE(a, b)",
1418
1418
  params: [
1419
1419
  {
@@ -1440,7 +1440,7 @@ var doc = [
1440
1440
  },
1441
1441
  {
1442
1442
  name: "ISAFTER",
1443
- description: "判断两个日期,是否第一个日期在第二个日期的后面",
1443
+ description: "判断两个日期,是否第一个日期在第二个日期的后面,是则返回 true,否则返回 false。",
1444
1444
  example: "ISAFTER(a, b)",
1445
1445
  params: [
1446
1446
  {
@@ -1467,7 +1467,7 @@ var doc = [
1467
1467
  },
1468
1468
  {
1469
1469
  name: "BETWEENRANGE",
1470
- description: "判断日期是否在指定范围内\n\n示例:BETWEENRANGE('2021/12/6', ['2021/12/5','2021/12/7'])",
1470
+ description: "判断日期是否在指定范围内,是则返回 true,否则返回 false。\n\n示例:BETWEENRANGE('2021/12/6', ['2021/12/5','2021/12/7'])",
1471
1471
  example: "BETWEENRANGE(date, [start, end])",
1472
1472
  params: [
1473
1473
  {
@@ -1499,7 +1499,7 @@ var doc = [
1499
1499
  },
1500
1500
  {
1501
1501
  name: "ISSAMEORBEFORE",
1502
- description: "判断两个日期,是否第一个日期在第二个日期的前面或者相等",
1502
+ description: "判断两个日期,是否第一个日期在第二个日期的前面或者相等,是则返回 true,否则返回 false。",
1503
1503
  example: "ISSAMEORBEFORE(a, b)",
1504
1504
  params: [
1505
1505
  {
@@ -1526,7 +1526,7 @@ var doc = [
1526
1526
  },
1527
1527
  {
1528
1528
  name: "ISSAMEORAFTER",
1529
- description: "判断两个日期,是否第一个日期在第二个日期的后面或者相等",
1529
+ description: "判断两个日期,是否第一个日期在第二个日期的后面或者相等,是则返回 true,否则返回 false。",
1530
1530
  example: "ISSAMEORAFTER(a, b)",
1531
1531
  params: [
1532
1532
  {
@@ -1553,7 +1553,7 @@ var doc = [
1553
1553
  },
1554
1554
  {
1555
1555
  name: "COUNT",
1556
- description: "返回数组的长度",
1556
+ description: "返回数组的长度。",
1557
1557
  example: "COUNT(arr)",
1558
1558
  params: [
1559
1559
  {
@@ -1614,7 +1614,7 @@ var doc = [
1614
1614
  },
1615
1615
  {
1616
1616
  name: "ARRAYFINDINDEX",
1617
- description: "数据做数据查找,需要搭配箭头函数一起使用,注意箭头函数只支持单表达式用法。\n找出第二个箭头函数返回为 true 的成员的索引。\n\n示例:\n\nARRAYFINDINDEX([0, 2, false], item => item === 2) 得到 1",
1617
+ description: "数据做数据查找,需要搭配箭头函数一起使用,注意箭头函数只支持单表达式用法。\n找出第二个箭头函数返回为 true 的成员的索引。\n\n示例:\n\nARRAYFINDINDEX([0, 2, false], item => item === 2) 得到 1",
1618
1618
  example: "ARRAYFINDINDEX(arr, item => item === 2)",
1619
1619
  params: [
1620
1620
  {
@@ -1636,7 +1636,7 @@ var doc = [
1636
1636
  },
1637
1637
  {
1638
1638
  name: "ARRAYFIND",
1639
- description: "数据做数据查找,需要搭配箭头函数一起使用,注意箭头函数只支持单表达式用法。\n找出第二个箭头函数返回为 true 的成员。\n\n示例:\n\nARRAYFIND([0, 2, false], item => item === 2) 得到 2",
1639
+ description: "数据做数据查找,需要搭配箭头函数一起使用,注意箭头函数只支持单表达式用法。\n找出第二个箭头函数返回为 true 的成员。\n\n示例:\n\nARRAYFIND([0, 2, false], item => item === 2) 得到 2",
1640
1640
  example: "ARRAYFIND(arr, item => item === 2)",
1641
1641
  params: [
1642
1642
  {
@@ -1658,7 +1658,7 @@ var doc = [
1658
1658
  },
1659
1659
  {
1660
1660
  name: "ARRAYSOME",
1661
- description: "数据做数据遍历判断,需要搭配箭头函数一起使用,注意箭头函数只支持单表达式用法。\n判断第二个箭头函数是否存在返回为 true 的成员。\n\n示例:\n\nARRAYSOME([0, 2, false], item => item === 2) 得到 true",
1661
+ description: "数据做数据遍历判断,需要搭配箭头函数一起使用,注意箭头函数只支持单表达式用法。\n判断第二个箭头函数是否存在返回为 true 的成员,是则返回 true,否则返回 false。\n\n示例:\n\nARRAYSOME([0, 2, false], item => item === 2) 得到 true",
1662
1662
  example: "ARRAYSOME(arr, item => item === 2)",
1663
1663
  params: [
1664
1664
  {
@@ -1680,7 +1680,7 @@ var doc = [
1680
1680
  },
1681
1681
  {
1682
1682
  name: "ARRAYEVERY",
1683
- description: "数据做数据遍历判断,需要搭配箭头函数一起使用,注意箭头函数只支持单表达式用法。\n判断第二个箭头函数返回是否都为 true。\n\n示例:\n\nARRAYEVERY([0, 2, false], item => item === 2) 得到 false",
1683
+ description: "数据做数据遍历判断,需要搭配箭头函数一起使用,注意箭头函数只支持单表达式用法。\n判断第二个箭头函数返回是否都为 true,是则返回 true,否则返回 false。\n\n示例:\n\nARRAYEVERY([0, 2, false], item => item === 2) 得到 false",
1684
1684
  example: "ARRAYEVERY(arr, item => item === 2)",
1685
1685
  params: [
1686
1686
  {
@@ -1702,7 +1702,7 @@ var doc = [
1702
1702
  },
1703
1703
  {
1704
1704
  name: "ARRAYINCLUDES",
1705
- description: "判断数据中是否存在指定元素\n\n示例:\n\nARRAYINCLUDES([0, 2, false], 2) 得到 true",
1705
+ description: "判断数据中是否存在指定元素。\n\n示例:\n\nARRAYINCLUDES([0, 2, false], 2) 得到 true",
1706
1706
  example: "ARRAYINCLUDES(arr, 2)",
1707
1707
  params: [
1708
1708
  {
@@ -1724,7 +1724,7 @@ var doc = [
1724
1724
  },
1725
1725
  {
1726
1726
  name: "COMPACT",
1727
- description: "数组过滤掉 false、null、0 和 \"\"\n\n示例:\n\nCOMPACT([0, 1, false, 2, '', 3]) 得到 [1, 2, 3]",
1727
+ description: "数组过滤掉 false、null、0 和 \"\"。\n\n示例:\n\nCOMPACT([0, 1, false, 2, '', 3]) 得到 [1, 2, 3]",
1728
1728
  example: "COMPACT(arr)",
1729
1729
  params: [
1730
1730
  {
@@ -1741,7 +1741,7 @@ var doc = [
1741
1741
  },
1742
1742
  {
1743
1743
  name: "JOIN",
1744
- description: "数组转成字符串\n\n示例:\n\nJOIN(['a', 'b', 'c'], '=') 得到 'a=b=c'",
1744
+ description: "数组转成字符串。\n\n示例:\n\nJOIN(['a', 'b', 'c'], '=') 得到 'a=b=c'",
1745
1745
  example: "JOIN(arr, string)",
1746
1746
  params: [
1747
1747
  {
@@ -1763,7 +1763,7 @@ var doc = [
1763
1763
  },
1764
1764
  {
1765
1765
  name: "CONCAT",
1766
- description: "数组合并\n\n示例:\n\nCONCAT(['a', 'b', 'c'], ['1'], ['3']) 得到 ['a', 'b', 'c', '1', '3']",
1766
+ description: "数组合并。\n\n示例:\n\nCONCAT(['a', 'b', 'c'], ['1'], ['3']) 得到 ['a', 'b', 'c', '1', '3']",
1767
1767
  example: "CONCAT(['a', 'b', 'c'], ['1'], ['3'])",
1768
1768
  params: [
1769
1769
  {
@@ -1780,7 +1780,7 @@ var doc = [
1780
1780
  },
1781
1781
  {
1782
1782
  name: "UNIQ",
1783
- description: "数组去重,第二个参数「field」,可指定根据该字段去重\n\n示例:\n\nUNIQ([{a: '1'}, {b: '2'}, {a: '1'}], 'id')",
1783
+ description: "数组去重,第二个参数「field」,可指定根据该字段去重。\n\n示例:\n\nUNIQ([{a: '1'}, {b: '2'}, {a: '1'}], 'id')",
1784
1784
  example: "UNIQ([{a: '1'}, {b: '2'}, {a: '1'}], 'x')",
1785
1785
  params: [
1786
1786
  {
@@ -1802,7 +1802,7 @@ var doc = [
1802
1802
  },
1803
1803
  {
1804
1804
  name: "ENCODEJSON",
1805
- description: "将JS对象转换成JSON字符串\n\n示例:\n\nENCODEJSON({name: 'amis'}) 得到 '{\"name\":\"amis\"}'",
1805
+ description: "将JS对象转换成JSON字符串。\n\n示例:\n\nENCODEJSON({name: 'amis'}) 得到 '{\"name\":\"amis\"}'",
1806
1806
  example: "ENCODEJSON({name: 'amis'})",
1807
1807
  params: [
1808
1808
  {
@@ -1819,7 +1819,7 @@ var doc = [
1819
1819
  },
1820
1820
  {
1821
1821
  name: "DECODEJSON",
1822
- description: "解析JSON编码数据,返回JS对象\n\n示例:\n\nDECODEJSON('{\\\"name\\\": \"amis\"}') 得到 {name: 'amis'}",
1822
+ description: "解析JSON编码数据,返回JS对象。\n\n示例:\n\nDECODEJSON('{\\\"name\\\": \"amis\"}') 得到 {name: 'amis'}",
1823
1823
  example: "DECODEJSON('{\\\"name\\\": \"amis\"}')",
1824
1824
  params: [
1825
1825
  {
@@ -1836,7 +1836,7 @@ var doc = [
1836
1836
  },
1837
1837
  {
1838
1838
  name: "GET",
1839
- 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'",
1839
+ 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'",
1840
1840
  example: "GET(arr, 2)",
1841
1841
  params: [
1842
1842
  {