npm - amis-formula - Versions diffs - 1.2.5 → 1.2.9 - Mend

amis-formula 1.2.5 → 1.2.9

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.

Files changed (6) hide show

package/dist/doc.md CHANGED Viewed

@@ -65,7 +65,7 @@
  * `args:...any` 条件，返回值集合
-返回：`any` 返回第一个满足条件的结果，没有命中的返回 false。
+返回：`any` 第一个满足条件的结果，没有命中的返回 false。
 判断函数集合，相当于多个 else if 合并成一个。
@@ -81,7 +81,7 @@
  * `num:number` 数值
-返回：`number` 返回传入数值的绝对值
+返回：`number` 传入数值的绝对值
 返回传入数字的绝对值
@@ -91,7 +91,7 @@
  * `num:...number` 数值
-返回：`number` 返回所有传入值中最大的那个
+返回：`number` 所有传入值中最大的那个
 获取最大值
@@ -101,7 +101,7 @@
  * `num:...number` 数值
-返回：`number` 返回所有传入值中最小的那个
+返回：`number` 所有传入值中最小的那个
 获取最小值
@@ -111,7 +111,7 @@
  * `num:...number` 数值
-返回：`number` 返回所有传入数值的总和
+返回：`number` 所有传入数值的总和
 求和
@@ -121,7 +121,7 @@
  * `num:number` 数值
-返回：`number` 返回数值对应的整形
+返回：`number` 数值对应的整形
 将数值向下取整为最接近的整数
@@ -132,7 +132,7 @@
  * `num:number` 被除数
  * `divisor:number` 除数
-返回：`number` 返回两数相除的余数
+返回：`number` 两数相除的余数
 返回两数相除的余数，参数 number 是被除数，divisor 是除数
@@ -149,7 +149,7 @@
  * `num:number` 要处理的数字
  * `numDigits:number` 小数位数
-返回：`number` 返回传入数值四舍五入后的结果
+返回：`number` 传入数值四舍五入后的结果
 将数字四舍五入到指定的位数，可以设置小数位。
@@ -160,7 +160,7 @@
  * `num:number` 要处理的数字
  * `numDigits:number` 小数位数
-返回：`number` 返回传入数值向下取整后的结果
+返回：`number` 传入数值向下取整后的结果
 将数字向下取整到指定的位数，可以设置小数位。
@@ -171,7 +171,7 @@
  * `num:number` 要处理的数字
  * `numDigits:number` 小数位数
-返回：`number` 返回传入数值向上取整后的结果
+返回：`number` 传入数值向上取整后的结果
 将数字向上取整到指定的位数，可以设置小数位。
@@ -181,7 +181,7 @@
  * `num:number` 要处理的数字
-返回：`number` 返回开平方的结果
+返回：`number` 开平方的结果
 开平方，参数 number 为非负数
@@ -191,17 +191,58 @@
  * `num:...number` 要处理的数字
-返回：`number` 返回所有数值的平均值
+返回：`number` 所有数值的平均值
 返回所有参数的平均值
+### DEVSQ
+用法：`DEVSQ(num1, num2, ...numN)`
+ * `num:...number` 要处理的数字
+返回：`number` 所有数值的平均值
+返回数据点与数据均值点之差（数据偏差）的平方和
+### AVEDEV
+用法：`AVEDEV(num1, num2, ...numN)`
+ * `num:...number` 要处理的数字
+返回：`number` 所有数值的平均值
+数据点到其算术平均值的绝对偏差的平均值
+### HARMEAN
+用法：`HARMEAN(num1, num2, ...numN)`
+ * `num:...number` 要处理的数字
+返回：`number` 所有数值的平均值
+数据点的调和平均值
+### LARGE
+用法：`LARGE(array, k)`
+ * `nums:array` 要处理的数字
+ * `k:number` 第几大
+返回：`number` 所有数值的平均值
+数据集中第 k 个最大值
 ### UPPERMONEY
 用法：`UPPERMONEY(num)`
  * `num:number` 要处理的数字
-返回：`string` 返回数值中文大写字符
+返回：`string` 数值中文大写字符
 将数值转为中文大写金额
@@ -255,7 +296,7 @@
  * `textArr:Array<string>` 要处理的文本集合
-返回：`Array<number>` 返回长度集合
+返回：`Array<number>` 长度集合
 计算文本集合中所有文本的长度
@@ -265,7 +306,7 @@
  * `text:string` 要处理的文本
-返回：`boolean` 返回判断结果
+返回：`boolean` 判断结果
 判断文本是否为空
@@ -275,7 +316,7 @@
  * `text:...string` 文本集合
-返回：`string` 返回连接后的文本
+返回：`string` 连接后的文本
 将多个传入值连接成文本
@@ -285,7 +326,7 @@
  * `code:number` 编码值
-返回：`string` 返回指定位置的字符
+返回：`string` 指定位置的字符
 返回计算机字符集的数字代码所对应的字符。
@@ -297,7 +338,7 @@
  * `text:string` 文本
-返回：`string` 返回结果文本
+返回：`string` 结果文本
 将传入文本转成小写
@@ -307,10 +348,90 @@
  * `text:string` 文本
-返回：`string` 返回结果文本
+返回：`string` 结果文本
 将传入文本转成大写
+### UPPERFIRST
+用法：`UPPERFIRST(text)`
+ * `text:string` 文本
+返回：`string` 结果文本
+将传入文本首字母转成大写
+### PADSTART
+用法：`PADSTART(text)`
+ * `text:string` 文本
+ * `num:number` 目标长度
+ * `pad:string` 用于补齐的文本
+返回：`string` 结果文本
+向前补齐文本长度
+示例 `PADSTART("6", 2, "0")`
+返回 `06`
+### CAPITALIZE
+用法：`CAPITALIZE(text)`
+ * `text:string` 文本
+返回：`string` 结果文本
+将文本转成标题
+示例 `CAPITALIZE("star")`
+返回 `Star`
+### ESCAPE
+用法：`ESCAPE(text)`
+ * `text:string` 文本
+返回：`string` 结果文本
+对文本进行 HTML 转义
+示例 `ESCAPE("star")`
+返回 `Star`
+### TRUNCATE
+用法：`TRUNCATE(text, 6)`
+ * `text:string` 文本
+ * `text:number` 最长长度
+返回：`string` 结果文本
+对文本长度进行截断
+示例 `TRUNCATE("amis.baidu.com", 6)`
+返回 `amis...`
+### BEFORELAST
+用法：`BEFORELAST(text, '.')`
+ * `text:string` 文本
+ * `delimiter:string` 结束文本
+返回：`string` 判断结果
+取在某个分隔符之前的所有字符串
 ### SPLIT
 用法：`SPLIT(text, ',')`
@@ -318,7 +439,7 @@
  * `text:string` 文本
  * `delimiter:string` 文本片段
-返回：`Array<string>` 返回文本集
+返回：`Array<string>` 文本集
 将文本根据指定片段分割成数组
@@ -332,10 +453,38 @@
  * `text:string` 文本
-返回：`string` 返回处理后的文本
+返回：`string` 处理后的文本
 将文本去除前后空格
+### STRIPTAG
+用法：`STRIPTAG(text)`
+ * `text:string` 文本
+返回：`string` 处理后的文本
+去除文本中的 HTML 标签
+示例：`STRIPTAG("<b>amis</b>")`
+返回：`amis`
+### LINEBREAK
+用法：`LINEBREAK(text)`
+ * `text:string` 文本
+返回：`string` 处理后的文本
+将字符串中的换行转成 HTML `<br>`，用于简单换行的场景
+示例：`LINEBREAK("\n")`
+返回：`<br/>`
 ### STARTSWITH
 用法：`STARTSWITH(text, '片段')`
@@ -343,10 +492,21 @@
  * `text:string` 文本
  * `startString:string` 起始文本
-返回：`string` 返回判断结果
+返回：`string` 判断结果
 判断字符串(text)是否以特定字符串(startString)开始，是则返回 True，否则返回 False
+### ENDSWITH
+用法：`ENDSWITH(text, '片段')`
+ * `text:string` 文本
+ * `endString:string` 结束文本
+返回：`string` 判断结果
+判断字符串(text)是否以特定字符串(endString)结束，是则返回 True，否则返回 False
 ### CONTAINS
 用法：`CONTAINS(text, searchText)`
@@ -354,7 +514,7 @@
  * `text:string` 文本
  * `searchText:string` 搜索文本
-返回：`string` 返回判断结果
+返回：`string` 判断结果
 判断参数 1 中的文本是否包含参数 2 中的文本。
@@ -366,7 +526,7 @@
  * `search:string` 要被替换的文本
  * `replace:string` 要替换的文本
-返回：`string` 返回处理结果
+返回：`string` 处理结果
 对文本进行全量替换。
@@ -378,7 +538,7 @@
  * `search:string` 用来搜索的文本
  * `start:number` 起始位置
-返回：`number` 返回命中的位置
+返回：`number` 命中的位置
 对文本进行搜索，返回命中的位置
@@ -390,7 +550,7 @@
  * `from:number` 起始位置
  * `len:number` 处理长度
-返回：`number` 返回命中的位置
+返回：`number` 命中的位置
 返回文本字符串中从指定位置开始的特定数目的字符
@@ -412,7 +572,7 @@
  * `date:date` 日期对象
  * `format:string` 时间戳格式，带毫秒传入 'x'。默认为 'X' 不带毫秒的。
-返回：`number` 返回时间戳
+返回：`number` 时间戳
 返回时间的时间戳
@@ -435,7 +595,7 @@
  * `date:date` 日期对象
  * `format:string` 日期格式，默认为 "YYYY-MM-DD HH:mm:ss"
-返回：`number` 返回日期字符串
+返回：`number` 日期字符串
 将日期转成日期字符串
@@ -467,7 +627,7 @@
  * `date:date` 日期对象
-返回：`number` 返回数值
+返回：`number` 数值
 返回日期的年份
@@ -477,7 +637,7 @@
  * `date:date` 日期对象
-返回：`number` 返回数值
+返回：`number` 数值
 返回日期的月份，这里就是自然月份。
@@ -487,7 +647,7 @@
  * `date:date` 日期对象
-返回：`number` 返回数值
+返回：`number` 数值
 返回日期的天
@@ -497,7 +657,7 @@
  * `date:date` 日期对象
-返回：`number` 返回数值
+返回：`number` 数值
 返回日期的小时
@@ -507,7 +667,7 @@
  * `date:date` 日期对象
-返回：`number` 返回数值
+返回：`number` 数值
 返回日期的分
@@ -517,7 +677,7 @@
  * `date:date` 日期对象
-返回：`number` 返回数值
+返回：`number` 数值
 返回日期的秒
@@ -528,7 +688,7 @@
  * `endDate:date` 日期对象
  * `startDate:date` 日期对象
-返回：`number` 返回数值
+返回：`number` 数值
 返回两个日期相差多少年
@@ -539,7 +699,7 @@
  * `endDate:date` 日期对象
  * `startDate:date` 日期对象
-返回：`number` 返回数值
+返回：`number` 数值
 返回两个日期相差多少分钟
@@ -550,7 +710,7 @@
  * `endDate:date` 日期对象
  * `startDate:date` 日期对象
-返回：`number` 返回数值
+返回：`number` 数值
 返回两个日期相差多少天
@@ -561,7 +721,7 @@
  * `endDate:date` 日期对象
  * `startDate:date` 日期对象
-返回：`number` 返回数值
+返回：`number` 数值
 返回两个日期相差多少小时
@@ -573,7 +733,7 @@
  * `num:number` 数值
  * `unit:string` 单位：支持年、月、天等等
-返回：`date` 返回日期对象
+返回：`date` 日期对象
 修改日期，对日期进行加减天、月份、年等操作
@@ -590,7 +750,7 @@ DATEMODIFY(A, -2, 'month')
  * `value:string` 日期字符
  * `format:string` 日期格式
-返回：`date` 返回日期对象
+返回：`date` 日期对象
 将字符日期转成日期对象，可以指定日期格式。
@@ -604,7 +764,7 @@ DATEMODIFY(A, -2, 'month')
  * `b:date` 第二个日期
  * `unit:string` 单位，默认是 'day'， 即之比较到天
-返回：`boolean` } 返回判断结果
+返回：`boolean` 判断结果
 判断两个日期，是否第一个日期在第二个日期的前面
@@ -616,7 +776,7 @@ DATEMODIFY(A, -2, 'month')
  * `b:date` 第二个日期
  * `unit:string` 单位，默认是 'day'， 即之比较到天
-返回：`boolean` } 返回判断结果
+返回：`boolean` 判断结果
 判断两个日期，是否第一个日期在第二个日期的后面
@@ -628,7 +788,7 @@ DATEMODIFY(A, -2, 'month')
  * `b:date` 第二个日期
  * `unit:string` 单位，默认是 'day'， 即之比较到天
-返回：`boolean` } 返回判断结果
+返回：`boolean` 判断结果
 判断两个日期，是否第一个日期在第二个日期的前面或者相等
@@ -640,7 +800,7 @@ DATEMODIFY(A, -2, 'month')
  * `b:date` 第二个日期
  * `unit:string` 单位，默认是 'day'， 即之比较到天
-返回：`boolean` } 返回判断结果
+返回：`boolean` 判断结果
 判断两个日期，是否第一个日期在第二个日期的后面或者相等
@@ -652,7 +812,7 @@ DATEMODIFY(A, -2, 'month')
  * `arr:Array<any>` 数组
-返回：`boolean` 返回结果
+返回：`boolean` 结果
 返回数组的长度