amis-formula 2.7.2 → 2.8.0

package/esm/evalutor.d.ts

@@ -804,17 +804,75 @@ export declare class Evaluator {
      */
     fnNOW(): Date;
     /**
-     * 将日期转成日期字符串
+     * 获取日期的星期几，
+     *
+     * 示例：
+     *
+     * WEEKDAY('2023-02-27') 得到 1
+     *
+     * @example WEEKDAY(date)
+     * @namespace 日期函数
+     * @param {any} date 日期
+     * @param {number} type 星期定义类型，默认为1，1表示0至6代表星期一到星期日，2表示1至7代表星期一到星期日
+     *
+     * @returns {number} 星期几的数字标识
+     */
+    fnWEEKDAY(date: Date | string | number, type?: number): number;
+    /**
+     * 获取年份的星期，即第几周
+     *
+     * 示例：
+     *
+     * WEEK('2023-03-05') 得到 10
+     *
+     * @example WEEK(date)
+     * @namespace 日期函数
+     * @param {any} date 日期
+     * @param {boolean} isISO 是否ISO星期
+     *
+     * @returns {number} 星期几的数字标识
+     */
+    fnWEEK(date: Date | string | number, isISO?: boolean): number;
+    /**
+     * 对日期、日期字符串、时间戳进行格式化
+     *
+     * 示例：
+     *
+     * 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'
      *
-     * @example DATETOSTR(date[, format="YYYY-MM-DD HH:mm:ss"])
      * @example DATETOSTR(date, 'YYYY-MM-DD')
      * @namespace 日期函数
-     * @param {date} date 日期对象
+     * @param {any} date 日期对象、日期字符串、时间戳
      * @param {string} format 日期格式，默认为 "YYYY-MM-DD HH:mm:ss"
      *
-     * @returns {number} 日期字符串
+     * @returns {string} 日期字符串
      */
-    fnDATETOSTR(date: Date, format?: string): string;
+    fnDATETOSTR(date: Date | string | number, format?: 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'
+     *
+     * @example DATERANGESPLIT(date, 'YYYY-MM-DD')
+     * @namespace 日期函数
+     * @param {string} date 日期范围字符串
+     * @param {string} key 取值标识，0或'start'表示获取开始时间，1或'end'表示获取结束时间
+     * @param {string} format 日期格式，可选
+     * @param {string} delimiter 分隔符，可选，默认为','
+     *
+     * @returns {string} 日期字符串
+     */
+    fnDATERANGESPLIT(daterange: string, key?: string, format?: string, delimiter?: string): string | string[];
     /**
      * 返回日期的指定范围的开端
      *
@@ -822,19 +880,22 @@ export declare class Evaluator {
      * @example STARTOF(date[unit = "day"])
      * @param {date} date 日期对象
      * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
+     * @param {string} format 日期格式，可选
      * @returns {date} 新的日期对象
      */
-    fnSTARTOF(date: Date, unit?: any): Date;
+    fnSTARTOF(date: Date, unit?: any, format?: string): string | Date;
     /**
      * 返回日期的指定范围的末尾
      * @namespace 日期函数
      * @example ENDOF(date[unit = "day"])
      * @param {date} date 日期对象
      * @param {string} unit 比如可以传入 'day'、'month'、'year' 或者 `week` 等等
+     * @param {string} format 日期格式，可选
      * @returns {date} 新的日期对象
      */
-    fnENDOF(date: Date, unit?: any): Date;
+    fnENDOF(date: Date, unit?: any, format?: string): string | Date;
     normalizeDate(raw: any): Date;
+    normalizeDateRange(raw: string | Date[]): Date[];
     /**
      * 返回日期的年份
      * @namespace 日期函数
@@ -971,6 +1032,20 @@ export declare class Evaluator {
      * @returns {boolean} 判断结果
      */
     fnISAFTER(a: Date, b: Date, unit?: any): boolean;
+    /**
+     * 判断日期是否在指定范围内
+     *
+     * 示例：BETWEENRANGE('2021/12/6', ['2021/12/5','2021/12/7'])
+     *
+     * @param {any} date 第一个日期
+     * @param {any[]} daterange 日期范围
+     * @param {string} unit 单位，默认是 'day'， 即之比较到天
+     * @param {string} inclusivity 包容性规则，默认为'[]'。[ 表示包含、( 表示排除，如果使用包容性参数，则必须传入两个指示符，如'()'表示左右范围都排除
+     * @namespace 日期函数
+     * @example BETWEENRANGE(date, [start, end])
+     * @returns {boolean} 判断结果
+     */
+    fnBETWEENRANGE(date: Date, daterange: Date[], unit?: any, inclusivity?: '[]' | '()' | '(]' | '[)'): boolean;
     /**
      * 判断两个日期，是否第一个日期在第二个日期的前面或者相等
      *
@@ -1023,6 +1098,80 @@ export declare class Evaluator {
      * @returns {boolean} 结果
      */
     fnARRAYFILTER(value: any, iterator: any): any[];
+    /**
+     * 数据做数据查找，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+     * 找出第二个箭头函数返回为 true 的成员的索引。
+     *
+     * 示例：
+     *
+     * ARRAYFINDINDEX([0, 2, false], item => item === 2) 得到 1
+     *
+     * @param {Array<any>} arr 数组
+     * @param {Function<any>} iterator 箭头函数
+     * @namespace 数组
+     * @example ARRAYFINDINDEX(arr, item => item === 2)
+     * @returns {number} 结果
+     */
+    fnARRAYFINDINDEX(arr: any[], iterator: any): number;
+    /**
+     * 数据做数据查找，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+     * 找出第二个箭头函数返回为 true 的成员。
+     *
+     * 示例：
+     *
+     * ARRAYFIND([0, 2, false], item => item === 2) 得到 2
+     *
+     * @param {Array<any>} arr 数组
+     * @param {Function<any>} iterator 箭头函数
+     * @namespace 数组
+     * @example ARRAYFIND(arr, item => item === 2)
+     * @returns {any} 结果
+     */
+    fnARRAYFIND(arr: any[], iterator: any): any;
+    /**
+     * 数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+     * 判断第二个箭头函数是否存在返回为 true 的成员。
+     *
+     * 示例：
+     *
+     * ARRAYSOME([0, 2, false], item => item === 2) 得到 true
+     *
+     * @param {Array<any>} arr 数组
+     * @param {Function<any>} iterator 箭头函数
+     * @namespace 数组
+     * @example ARRAYSOME(arr, item => item === 2)
+     * @returns {boolean} 结果
+     */
+    fnARRAYSOME(arr: any[], iterator: any): boolean;
+    /**
+     * 数据做数据遍历判断，需要搭配箭头函数一起使用，注意箭头函数只支持单表达式用法。
+     * 判断第二个箭头函数返回是否都为 true。
+     *
+     * 示例：
+     *
+     * ARRAYEVERY([0, 2, false], item => item === 2) 得到 false
+     *
+     * @param {Array<any>} arr 数组
+     * @param {Function<any>} iterator 箭头函数
+     * @namespace 数组
+     * @example ARRAYEVERY(arr, item => item === 2)
+     * @returns {boolean} 结果
+     */
+    fnARRAYEVERY(arr: any[], iterator: any): boolean;
+    /**
+     * 判断数据中是否存在指定元素
+     *
+     * 示例：
+     *
+     * ARRAYINCLUDES([0, 2, false], 2) 得到 true
+     *
+     * @param {Array<any>} arr 数组
+     * @param {any} item 元素
+     * @namespace 数组
+     * @example ARRAYINCLUDES(arr, 2)
+     * @returns {any} 结果
+     */
+    fnARRAYINCLUDES(arr: any[], item: any): boolean;
     /**
      * 数组过滤掉 false、null、0 和 ""
      *
@@ -1078,13 +1227,58 @@ export declare class Evaluator {
      * @returns {Array<any>} 结果
      */
     fnUNIQ(arr: any[], field?: string): any[];
+    /**
+     * 将JS对象转换成JSON字符串
+     *
+     * 示例：
+     *
+     * ENCODEJSON({name: 'amis'}) 得到 '{"name":"amis"}'
+     *
+     * @param {object} obj JS对象
+     * @namespace 编码
+     * @example ENCODEJSON({name: 'amis'})
+     * @returns {string} 结果
+     */
+    fnENCODEJSON(obj: object): string;
+    /**
+     * 解析JSON编码数据，返回JS对象
+     *
+     * 示例：
+     *
+     * DECODEJSON('{\"name\": "amis"}') 得到 {name: 'amis'}
+     *
+     * @param {string} str 字符串
+     * @namespace 编码
+     * @example DECODEJSON('{\"name\": "amis"}')
+     * @returns {object} 结果
+     */
+    fnDECODEJSON(str: string): object;
+    /**
+     * 根据对象或者数组的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'
+     *
+     * @param {any} obj 对象或数组
+     * @param {string} path 路径
+     * @param {any} defaultValue 如果解析不到则返回该值
+     * @namespace 其他
+     * @example GET(arr, 2)
+     * @returns {any} 结果
+     */
+    fnGET(obj: any, path: string, defaultValue?: any): any;
     /**
      * 判断是否为类型支持：string, number, array, date, plain-object。
      *
      * @param {string} 判断对象
      * @namespace 其他
      * @example ISTYPE([{a: '1'}, {b: '2'}, {a: '1'}], 'array')
-     * @returns {boolean} 结果结果
+     * @returns {boolean} 结果
      */
     fnISTYPE(target: any, type: 'string' | 'number' | 'array' | 'date' | 'plain-object' | 'nil'): boolean;
 }