util-helpers 4.15.2 → 4.16.0

package/types/ajax.d.ts

@@ -0,0 +1,121 @@
+export default ajax;
+/**
+ * XMLHttpRequest 事件对象
+ */
+export type XMLHttpRequestEvent = XMLHttpRequest['onloadstart'];
+/**
+ * ajax配置项
+ */
+export type AjaxOptions = {
+    /**
+     * 创建请求时使用的方法
+     */
+    method?: string | undefined;
+    /**
+     * 请求体被发送的数据
+     */
+    data?: Document | XMLHttpRequestBodyInit | null | undefined;
+    /**
+     * 自定义请求头
+     */
+    headers?: {
+        [x: string]: string;
+    } | undefined;
+    /**
+     * 响应类型
+     */
+    responseType?: XMLHttpRequestResponseType | undefined;
+    /**
+     * 请求超时的毫秒数
+     */
+    timeout?: number | undefined;
+    /**
+     * 跨域请求时是否需要使用凭证
+     */
+    withCredentials?: boolean | undefined;
+    /**
+     * 是否异步执行操作
+     */
+    async?: boolean | undefined;
+    /**
+     * 用户名，用于认证用途
+     */
+    user?: string | null | undefined;
+    /**
+     * 密码，用于认证用途
+     */
+    password?: string | null | undefined;
+    /**
+     * 接收到响应数据时触发
+     */
+    onLoadStart?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
+    /**
+     * 请求接收到更多数据时，周期性地触发
+     */
+    onProgress?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
+    /**
+     * 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时
+     */
+    onAbort?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
+    /**
+     * 在预设时间内没有接收到响应时触发
+     */
+    onTimeout?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
+    /**
+     * 当 request 遭遇错误时触发
+     */
+    onError?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
+    /**
+     * 请求成功完成时触发
+     */
+    onLoad?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
+    /**
+     * 请求结束时触发，无论请求成功 (load) 还是失败 (abort 或 error)
+     */
+    onLoadEnd?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
+};
+/**
+ * @typedef {XMLHttpRequest['onloadstart']} XMLHttpRequestEvent XMLHttpRequest 事件对象
+ */
+/**
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest|XMLHttpRequest}
+ * @typedef {Object} AjaxOptions ajax配置项
+ * @property {string} [method="get"] 创建请求时使用的方法
+ * @property {Document | XMLHttpRequestBodyInit | null} [data=null] 请求体被发送的数据
+ * @property {Object.<string, string>} [headers] 自定义请求头
+ * @property {XMLHttpRequestResponseType} [responseType] 响应类型
+ * @property {number} [timeout] 请求超时的毫秒数
+ * @property {boolean} [withCredentials=false] 跨域请求时是否需要使用凭证
+ * @property {boolean} [async=true] 是否异步执行操作
+ * @property {string|null} [user=null] 用户名，用于认证用途
+ * @property {string|null} [password=null] 密码，用于认证用途
+ * @property {XMLHttpRequestEvent} [onLoadStart] 接收到响应数据时触发
+ * @property {XMLHttpRequestEvent} [onProgress] 请求接收到更多数据时，周期性地触发
+ * @property {XMLHttpRequestEvent} [onAbort] 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时
+ * @property {XMLHttpRequestEvent} [onTimeout] 在预设时间内没有接收到响应时触发
+ * @property {XMLHttpRequestEvent} [onError] 当 request 遭遇错误时触发
+ * @property {XMLHttpRequestEvent} [onLoad] 请求成功完成时触发
+ * @property {XMLHttpRequestEvent} [onLoadEnd] 请求结束时触发，无论请求成功 (load) 还是失败 (abort 或 error)
+ */
+/**
+ * 请求<br/><br/>
+ *
+ * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
+ *
+ * @static
+ * @alias module:Other.ajax
+ * @since 4.16.0
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest|XMLHttpRequest}
+ * @param {string} url 地址
+ * @param {AjaxOptions} [options] 配置项
+ * @returns {Promise<ProgressEvent<EventTarget>>}
+ * @example
+ * ajax('/somefile').then(res=>{
+ *   // do something
+ * });
+ *
+ * ajax('/api', { method: 'post' }).then(res=>{
+ *   // do something
+ * });
+ */
+declare function ajax(url: string, options?: AjaxOptions | undefined): Promise<ProgressEvent<EventTarget>>;

package/types/blobToDataURL.d.ts

@@ -1,11 +1,15 @@
 export default blobToDataURL;
 /**
- * 将 Blob 或 File 对象转成 data:URL 格式的 Base64 字符串。
+ * 将 Blob 或 File 对象转成 data:URL 格式的 Base64 字符串<br/><br/>
+ *
+ * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
  *
  * @static
  * @alias module:Processor.blobToDataURL
  * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader/readAsDataURL|FileReader.readAsDataURL()}
  * @since 4.1.0
+ * @ignore
+ * @deprecated 请使用 `fileReader` 方法
  * @param {Blob} blob Blob 或 File 对象
  * @returns {Promise<string>} data:URL 格式的 Base64 字符串。
  * @example

package/types/download.d.ts

@@ -0,0 +1,77 @@
+export default download;
+/**
+ * ajax 配置项
+ */
+export type AjaxOptions = import('./ajax.js').AjaxOptions;
+export type TransformRequest = (options: AjaxOptions) => AjaxOptions;
+export type TransformResponse = (res: Blob) => Blob;
+/**
+ * 下载配置项
+ */
+export type DownloadOptions = {
+    /**
+     * 文件名称
+     */
+    fileName?: string | undefined;
+    /**
+     * MIME 类型
+     */
+    type?: string | undefined;
+    /**
+     * 手动设置数据类型，默认会根据传入的数据判断类型，主要是为了区分 url 和 text 。<br/>如果你要下载的文本是 url ，请设置 'text' ；如果你要下载的 url 是绝对/相对路径，请设置 'url' 。
+     */
+    dataType?: "text" | "url" | undefined;
+    /**
+     * 请求前触发，XHR 对象或配置调整
+     */
+    transformRequest?: TransformRequest | undefined;
+    /**
+     * 请求成功后触发，在传递给 then/catch 前，允许修改响应数据
+     */
+    transformResponse?: TransformResponse | undefined;
+};
+/**
+ * @typedef {import('./ajax.js').AjaxOptions} AjaxOptions ajax 配置项
+ */
+/**
+ * @callback TransformRequest
+ * @param {AjaxOptions} options ajax 配置项
+ * @returns {AjaxOptions}
+ */
+/**
+ * @callback TransformResponse
+ * @param {Blob} res 响应的Blob对象。如果你通过 transformRequest 修改了 responseType ，该参数将是该类型响应值。
+ * @returns {Blob}
+ */
+/**
+ * @typedef {Object} DownloadOptions 下载配置项
+ * @property {string} [options.fileName] 文件名称
+ * @property {string} [options.type] MIME 类型
+ * @property {'url'|'text'} [options.dataType] 手动设置数据类型，默认会根据传入的数据判断类型，主要是为了区分 url 和 text 。<br/>如果你要下载的文本是 url ，请设置 'text' ；如果你要下载的 url 是绝对/相对路径，请设置 'url' 。
+ * @property {TransformRequest} [options.transformRequest] 请求前触发，XHR 对象或配置调整
+ * @property {TransformResponse} [options.transformResponse] 请求成功后触发，在传递给 then/catch 前，允许修改响应数据
+ */
+/**
+ * 下载<br/><br/>
+ *
+ * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端，兼容 IE10+ 和现代浏览器。</em>
+ *
+ * @static
+ * @alias module:Other.download
+ * @since 4.16.0
+ * @see {@link https://zh.wikipedia.org/wiki/多用途互聯網郵件擴展|多用途互联网邮件扩展}
+ * @param {string|Blob|ArrayBuffer|Int8Array|Uint8Array|Uint8ClampedArray|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array|BigInt64Array|BigUint64Array} data 字符串、blob数据或url地址
+ * @param {string|DownloadOptions} [options] 文件名称 或 配置项
+ * @returns {Promise<void>}
+ * @example
+ * // 文本
+ * download('hello world', 'text.txt');
+ *
+ * // 远程文件
+ * download('/xxx.jpg', { dataType: 'url' });
+ *
+ * // blob文件
+ * download(new Blob(['hello world']), 'text.txt');
+ *
+ */
+declare function download(data: string | Blob | ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array, options?: string | DownloadOptions | undefined): Promise<void>;

package/types/fileReader.d.ts

@@ -0,0 +1,3 @@
+export default fileReader;
+declare function fileReader(blob: Blob, type: 'arrayBuffer'): Promise<ArrayBuffer>;
+declare function fileReader(blob: Blob, type?: "text" | "binaryString" | "dataURL" | undefined): Promise<string>;

package/types/filterTree.d.ts

@@ -3,7 +3,7 @@ export default filterTree;
  * 过滤/筛选树节点。<br/><br/>如果某节点被过滤掉，它的子节点也一并抛弃
  *
  * @static
- * @alias module:Processor.filterTree
+ * @alias module:Tree.filterTree
  * @since 4.15.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/types/findTreeNode.d.ts

@@ -3,7 +3,7 @@ export default findTreeNode;
  * 查找树结构数据节点
  *
  * @static
- * @alias module:Other.findTreeNode
+ * @alias module:Tree.findTreeNode
  * @since 4.14.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/types/findTreeNodes.d.ts

@@ -3,7 +3,7 @@ export default findTreeNodes;
  * 查找树结构数据多个节点
  *
  * @static
- * @alias module:Other.findTreeNodes
+ * @alias module:Tree.findTreeNodes
  * @since 4.15.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/types/findTreeSelect.d.ts

@@ -3,7 +3,7 @@ export default findTreeSelect;
  * 查找包含当前节点的所有父级节点
  *
  * @static
- * @alias module:Other.findTreeSelect
+ * @alias module:Tree.findTreeSelect
  * @since 4.14.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/types/index.d.ts

@@ -27,25 +27,28 @@ export { default as numberToChinese } from "./numberToChinese";
 export { default as bytesToSize } from "./bytesToSize";
 export { default as parseIdCard } from "./parseIdCard";
 export { default as blobToDataURL } from "./blobToDataURL";
+export { default as fileReader } from "./fileReader";
 export { default as dataURLToBlob } from "./dataURLToBlob";
 export { default as setDataURLPrefix } from "./setDataURLPrefix";
 export { default as normalizeString } from "./normalizeString";
 export { default as safeDate } from "./safeDate";
 export { default as formatMobile } from "./formatMobile";
 export { default as padZero } from "./padZero";
-export { default as transformFieldNames } from "./transformFieldNames";
-export { default as listToTree } from "./listToTree";
-export { default as treeToList } from "./treeToList";
-export { default as filterTree } from "./filterTree";
 export { default as plus } from "./plus";
 export { default as minus } from "./minus";
 export { default as times } from "./times";
 export { default as divide } from "./divide";
 export { default as round } from "./round";
-export { default as waitTime } from "./waitTime";
+export { default as ajax } from "./ajax";
 export { default as calculateCursorPosition } from "./calculateCursorPosition";
+export { default as download } from "./download";
 export { default as randomString } from "./randomString";
 export { default as strlen } from "./strlen";
+export { default as waitTime } from "./waitTime";
+export { default as transformFieldNames } from "./transformFieldNames";
+export { default as listToTree } from "./listToTree";
+export { default as treeToList } from "./treeToList";
+export { default as filterTree } from "./filterTree";
 export { default as findTreeNode } from "./findTreeNode";
 export { default as findTreeNodes } from "./findTreeNodes";
 export { default as findTreeSelect } from "./findTreeSelect";

package/types/{transformFieldNames.type.d.ts → interface.type.d.ts}

@@ -1,2 +1,2 @@
 export type ExchangeFieldNames<D extends unknown, F extends Record<string, keyof D>> = Omit<D, F[keyof F]> & { [P in keyof F]: D[F[P]]; };
-export type TransformFieldNames<D extends unknown, F extends Record<string, keyof D>, C extends string> = (C extends keyof D ? ExchangeFieldNames<Omit<D, C> & Record<C, TransformFieldNames<D, F, C>>, F> : ExchangeFieldNames<D, F>)[];
+export type TransformFieldNames<D extends unknown, F extends Record<string, any>, C extends string> = (C extends keyof D ? ExchangeFieldNames<Omit<D, C> & Record<C, TransformFieldNames<D, F, C>>, F> : ExchangeFieldNames<D, F>)[];

package/types/listToTree.d.ts

@@ -3,7 +3,7 @@ export default listToTree;
  * 列表数据转树结构
  *
  * @static
- * @alias module:Processor.listToTree
+ * @alias module:Tree.listToTree
  * @since 4.14.0
  * @template {Record<string,any>} [T=Record<string,any>]
  * @template {*} [R=T&Record<string,any>]

package/types/numberToChinese.d.ts

@@ -1,7 +1,8 @@
 export default numberToChinese;
 /**
- * 数字转中文数字
- * 不在安全数字 -9007199254740991～9007199254740991 内，处理会有异常
+ * 数字转中文数字<br/><br/>
+ *
+ * 如果数字不在安全数字 -9007199254740991～9007199254740991 范围内，处理会有异常。
  *
  * @static
  * @alias module:Processor.numberToChinese

package/types/parseIdCard.d.ts

@@ -78,7 +78,7 @@ export type IdCardInfo = {
  * @since 4.0.0
  * @see 参考 {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
  * @param {string} id 身份证号码，支持15位
- * @returns {null|IdCardInfo} null 或 省份、生日、性别，省/市/区/年/月/日/性别编码
+ * @returns {IdCardInfo | null} 省份、生日、性别，省/市/区/年/月/日/性别编码。如果解析失败将返回 null 。
  * @example
  *
  * parseIdCard('123456789123456'); // null
@@ -104,4 +104,4 @@ export type IdCardInfo = {
  * }
  *
  */
-declare function parseIdCard(id: string): null | IdCardInfo;
+declare function parseIdCard(id: string): IdCardInfo | null;

package/types/replaceChar.d.ts

@@ -15,20 +15,24 @@ export default replaceChar;
  * @returns {string} 处理后的字符
  * @example
  *
- * // 手机号
+ * // 手机号 前3后4
  * replaceChar('13000000000'); // 130****0000
  *
- * // 身份证
- * replaceChar('130701199310302288'); // 130***********2288
+ * // 身份证 前6后4
+ * replaceChar('130701199310302288', { start: 6, end: -4 }); // 130701********2288
  *
- * // 邮箱
+ * // 邮箱 @前两位
  * const email = '12345@qq.com'
+ * const emailAtIndex = email.indexOf('@');
+ * replaceChar(email, { start: emailAtIndex - 2, end: emailAtIndex }); // 123**@qq.com
+ * // 邮箱 前2和@后面内容，固定替换字符4位
  * replaceChar(email, {start: 2, end: email.indexOf('@'), repeat: 4}); // 12****@qq.com
  *
- * // 银行卡号
+ * // 银行卡号 只展示后4位，固定替换字符4位
  * replaceChar('6228480402564890018', {start: 0, end: -4, repeat: 4}); // ****0018
- *
- * // 带格式的银行卡号，忽略空字符串
+ * // 银行卡号 前6后4
+ * replaceChar('6228480402564890018', { start: 6, end: -4 }); // 622848*********0018
+ * // 银行卡号 前4后3 忽略格式的空格
  * replaceChar('6228 4804 0256 4890 018', {start: 4, end: -4, exclude: ' '}); // 6228 **** **** **** 018
  *
  * // 用户名

package/types/safeDate.d.ts

@@ -1,24 +1,4 @@
 export default safeDate;
-/**
- * 创建一个 Date 实例日期对象，同 new Date() 。<br/>
- * 规避了苹果设备浏览器不支持部分格式（YYYY-MM-DD HH-mm 或 YYYY.MM.DD）。
- *
- * @static
- * @alias module:Processor.safeDate
- * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Date|Date}
- * @since 4.4.0
- * @param {string|number|Date} [value] 日期时间字符串、毫秒数、日期对象
- * @param {...number} args 月/日/时/分/秒/毫秒
- * @returns {Date} Date 实例日期对象
- * @example
- *
- * safeDate('2022-1-1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
- * safeDate('2022/1/1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
- * safeDate('2022.1.1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
- * safeDate('2022.1.1 11:11'); // Sat Jan 01 2022 11:11:00 GMT+0800 (中国标准时间)
- * safeDate(99, 1); // Mon Feb 01 1999 00:00:00 GMT+0800 (中国标准时间)
- * safeDate(1646711233171); // Tue Mar 08 2022 11:47:13 GMT+0800 (中国标准时间)
- *
- *
- */
-declare function safeDate(value?: string | number | Date | undefined, ...args: number[]): Date;
+declare function safeDate(): Date;
+declare function safeDate(value: number | string | Date): Date;
+declare function safeDate(year: number, monthIndex: number, date?: number | undefined, hours?: number | undefined, minutes?: number | undefined, seconds?: number | undefined, ms?: number | undefined): Date;

package/types/transformFieldNames.d.ts

@@ -12,7 +12,7 @@ export default transformFieldNames;
  * @param {F} fieldNames 字段名映射
  * @param {C} [childrenField] 子级数据字段名
  * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
- * @returns {import('./transformFieldNames.type.js').TransformFieldNames<D, F, C>}
+ * @returns {import('./interface.type.js').TransformFieldNames<D, F, C>}
  * @example
  *
  * const options = [{code: '1', name: 'one'},{code:'2', name:'two'}];
@@ -32,4 +32,4 @@ export default transformFieldNames;
  * const newOptions4 = transformFieldNames(options3, {label: 'name', value: 'code', children: 'childs'}, 'childs');
  * // [{value: '1', label: 'one'},{value:'2', label:'two', children: [{value: '2-1', label:'two-one'}]}]
  */
-declare function transformFieldNames<D extends unknown, F extends Record<string, keyof D>, C extends string>(data: D[], fieldNames: F, childrenField?: C | undefined, nodeAssign?: "spread" | "self" | undefined): import("./transformFieldNames.type.js").TransformFieldNames<D, F, C>;
+declare function transformFieldNames<D extends unknown, F extends Record<string, keyof D>, C extends string>(data: D[], fieldNames: F, childrenField?: C | undefined, nodeAssign?: "spread" | "self" | undefined): import("./interface.type.js").TransformFieldNames<D, F, C>;

package/types/treeToList.d.ts

@@ -3,7 +3,7 @@ export default treeToList;
  * 树结构转列表数据
  *
  * @static
- * @alias module:Processor.treeToList
+ * @alias module:Tree.treeToList
  * @since 4.14.0
  * @template {Record<string,any>} T
  * @template {keyof T} K

package/types/utils/type/index.d.ts

@@ -1,19 +1,21 @@
-import isArguments from "./isArguments";
-import isArray from "./isArray";
-import isBoolean from "./isBoolean";
-import isDate from "./isDate";
-import isError from "./isError";
-import isFunction from "./isFunction";
-import isObject from "./isObject";
-import isNull from "./isNull";
-import isNaN from "./isNaN";
-import isNumber from "./isNumber";
-import isRegExp from "./isRegExp";
-import isString from "./isString";
-import isSymbol from "./isSymbol";
-import isMap from "./isMap";
-import isWeakMap from "./isWeakMap";
-import isSet from "./isSet";
-import isWeakSet from "./isWeakSet";
-import isUndefined from "./isUndefined";
-export { isArguments, isArray, isBoolean, isDate, isError, isFunction, isObject, isNull, isNaN, isNumber, isRegExp, isString, isSymbol, isMap, isWeakMap, isSet, isWeakSet, isUndefined };
+import isArguments from './isArguments';
+import isArray from './isArray';
+import isArrayBuffer from './isArrayBuffer';
+import isBlob from './isBlob';
+import isBoolean from './isBoolean';
+import isDate from './isDate';
+import isError from './isError';
+import isFunction from './isFunction';
+import isObject from './isObject';
+import isNull from './isNull';
+import isNaN from './isNaN';
+import isNumber from './isNumber';
+import isRegExp from './isRegExp';
+import isString from './isString';
+import isSymbol from './isSymbol';
+import isMap from './isMap';
+import isWeakMap from './isWeakMap';
+import isSet from './isSet';
+import isWeakSet from './isWeakSet';
+import isUndefined from './isUndefined';
+export { isArguments, isArray, isArrayBuffer, isBlob, isBoolean, isDate, isError, isFunction, isObject, isNull, isNaN, isNumber, isRegExp, isString, isSymbol, isMap, isWeakMap, isSet, isWeakSet, isUndefined };

package/types/utils/type/isArrayBuffer.d.ts

@@ -0,0 +1,21 @@
+export default isArrayBuffer;
+/**
+ * 检查值是否为ArrayBuffer对象
+ *
+ * @static
+ * @alias module:Type.isArrayBuffer
+ * @since 4.16.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为ArrayBuffer对象
+ * @example
+ *
+ * isArrayBuffer(new ArrayBuffer(8))
+ * // => true
+ *
+ * isArrayBuffer({})
+ * // => false
+ *
+ * isArrayBuffer('2012')
+ * // => false
+ */
+declare function isArrayBuffer(value: any): boolean;

package/types/utils/type/isBlob.d.ts

@@ -0,0 +1,23 @@
+export default isBlob;
+/**
+ * 检查值是否为Blob对象<br/><br/>
+ *
+ * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
+ *
+ * @static
+ * @alias module:Type.isBlob
+ * @since 4.16.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Blob对象
+ * @example
+ *
+ * isBlob(new Blob(['a']))
+ * // => true
+ *
+ * isBlob({})
+ * // => false
+ *
+ * isBlob('2012')
+ * // => false
+ */
+declare function isBlob(value: any): boolean;

package/esm/transformFieldNames.doc.js

@@ -1,35 +0,0 @@
-/* eslint-disable no-unused-vars */
-// 该文件用于 jsdoc 生成文件。因为一些 typescript 语法， jsdoc 不支持，导致生成文档报错。
-
-/**
- * 转换字段名，返回一个转换字段后的值，不改变原值。
- * 
- * @static
- * @alias module:Processor.transformFieldNames
- * @since 4.14.0
- * @param {object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
- * @param {object} fieldNames 字段名映射
- * @param {string} [childrenField] 子级数据字段名
- * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
- * @returns {object[]}
- * @example
- * 
- * const options = [{code: '1', name: 'one'},{code:'2', name:'two'}];
- * const newOptions = transformFieldNames(options, {label: 'name', value: 'code'});
- * // [{value: '1', label: 'one'},{value:'2', label:'two'}]
- * 
- * // 嵌套数据，指定子级字段名 children
- * const options2 = [{code: '1', name: 'one'},{code:'2', name:'two', children: [{code:'2-1', name:'two-one', children: [{code: '2-1-1', name:'two-one-one'}]}]}];
- * const newOptions2 = transformFieldNames(options2, {label: 'name', value: 'code'}, 'children');
- * // [{value: '1', label: 'one'},{value:'2', label:'two', children: [{value: '2-1', label:'two-one', children: [{value: '2-1-1', label:'two-one-one'}]}]}]
- * 
- * const options3 = [{code: '1', name: 'one'},{code:'2', name:'two', childs: [{code:'2-1', name:'two-one'}]}];
- * const newOptions3 = transformFieldNames(options3, {label: 'name', value: 'code'}, 'childs');
- * // [{value: '1', label: 'one'},{value:'2', label:'two', childs: [{value: '2-1', label:'two-one'}]}]
- * 
- * // 嵌套数据，并替换子集字段名
- * const newOptions4 = transformFieldNames(options3, {label: 'name', value: 'code', children: 'childs'}, 'childs');
- * // [{value: '1', label: 'one'},{value:'2', label:'two', children: [{value: '2-1', label:'two-one'}]}]
- */
-function transformFieldNames(data, fieldNames, childrenField) {}
-export default transformFieldNames;

package/lib/transformFieldNames.doc.js

@@ -1,42 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-/* eslint-disable no-unused-vars */
-// 该文件用于 jsdoc 生成文件。因为一些 typescript 语法， jsdoc 不支持，导致生成文档报错。
-
-/**
- * 转换字段名，返回一个转换字段后的值，不改变原值。
- * 
- * @static
- * @alias module:Processor.transformFieldNames
- * @since 4.14.0
- * @param {object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
- * @param {object} fieldNames 字段名映射
- * @param {string} [childrenField] 子级数据字段名
- * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
- * @returns {object[]}
- * @example
- * 
- * const options = [{code: '1', name: 'one'},{code:'2', name:'two'}];
- * const newOptions = transformFieldNames(options, {label: 'name', value: 'code'});
- * // [{value: '1', label: 'one'},{value:'2', label:'two'}]
- * 
- * // 嵌套数据，指定子级字段名 children
- * const options2 = [{code: '1', name: 'one'},{code:'2', name:'two', children: [{code:'2-1', name:'two-one', children: [{code: '2-1-1', name:'two-one-one'}]}]}];
- * const newOptions2 = transformFieldNames(options2, {label: 'name', value: 'code'}, 'children');
- * // [{value: '1', label: 'one'},{value:'2', label:'two', children: [{value: '2-1', label:'two-one', children: [{value: '2-1-1', label:'two-one-one'}]}]}]
- * 
- * const options3 = [{code: '1', name: 'one'},{code:'2', name:'two', childs: [{code:'2-1', name:'two-one'}]}];
- * const newOptions3 = transformFieldNames(options3, {label: 'name', value: 'code'}, 'childs');
- * // [{value: '1', label: 'one'},{value:'2', label:'two', childs: [{value: '2-1', label:'two-one'}]}]
- * 
- * // 嵌套数据，并替换子集字段名
- * const newOptions4 = transformFieldNames(options3, {label: 'name', value: 'code', children: 'childs'}, 'childs');
- * // [{value: '1', label: 'one'},{value:'2', label:'two', children: [{value: '2-1', label:'two-one'}]}]
- */
-function transformFieldNames(data, fieldNames, childrenField) {}
-var _default = transformFieldNames;
-exports["default"] = _default;