util-helpers 4.16.2 → 4.17.0

package/esm/interface.doc.js

@@ -1,125 +0,0 @@
-/* eslint-disable no-unused-vars */
-// 该文件用于 jsdoc 生成文件。因为一些 typescript 语法， jsdoc 不支持，导致生成文档报错。
-
-/**
- * 转换字段名，返回一个转换字段后的值，不改变原值。
- * 
- * @static
- * @alias module:Tree.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) {}
-
-/**
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest|XMLHttpRequest}
- * @typedef {Object} AjaxOptions ajax配置项
- * @property {string} [method="get"] 创建请求时使用的方法
- * @property {*} [data=null] 请求体被发送的数据
- * @property {object} [headers] 自定义请求头
- * @property {string} [responseType] 响应类型
- * @property {number} [timeout] 请求超时的毫秒数
- * @property {boolean} [withCredentials=false] 跨域请求时是否需要使用凭证
- * @property {boolean} [async=true] 是否异步执行操作
- * @property {string|null} [user=null] 用户名，用于认证用途
- * @property {string|null} [password=null] 密码，用于认证用途
- * @property {function} [onLoadStart] 接收到响应数据时触发
- * @property {function} [onProgress] 请求接收到更多数据时，周期性地触发
- * @property {function} [onAbort] 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时
- * @property {function} [onTimeout] 在预设时间内没有接收到响应时触发
- * @property {function} [onError] 当 request 遭遇错误时触发
- * @property {function} [onLoad] 请求成功完成时触发
- * @property {function} [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<object>} XHR 事件对象
- * @example
- * ajax('/somefile').then(res=>{
- *   // do something
- * });
- * 
- * ajax('/api', { method: 'post' }).then(res=>{
- *   // do something
- * });
- */
-function ajax(url, options) {}
-
-/**
- * @callback TransformRequest
- * @param {AjaxOptions} options ajax 配置项
- * @returns {AjaxOptions | Promise<AjaxOptions>}
- */
-
-/**
- * @callback TransformResponse
- * @param {Blob} res 响应的Blob对象。如果你通过 transformRequest 修改了 responseType ，该参数将是该类型响应值。
- * @returns {Blob | Promise<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/多用途互聯網郵件擴展|MIME}
- * @see {@link https://9ykc9s.csb.app/|在线示例}
- * @param {string|Blob|TypedArray} 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');
- * 
- */
-function download(data, fileName, options) {}

package/esm/interface.type.js

@@ -1,17 +0,0 @@
-// 交换字段名
-/**
- * @template {*} D
- * @template {Record<string, keyof D>} F
- * @typedef {Omit<D, F[keyof F]> & { [P in keyof F]: D[F[P]] }} ExchangeFieldNames
- */
-
-// 交换字段名，支持嵌套
-// 先排除子级字段名，再交换字段名，然后加上子级字段名，再替换一次。
-/**
- * @template {*} D
- * @template {Record<string, any>} F
- * @template {string} C
- * @typedef {(C extends keyof D ? ExchangeFieldNames<Omit<D, C> & Record<C, TransformFieldNames<D, F, C>>, F> : ExchangeFieldNames<D, F>)[]} TransformFieldNames
- */
-
-export {};

package/esm/utils/type/index.js

@@ -1,29 +0,0 @@
-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';
-
-/**
- * 类型检测
- *
- * @module Type
- * @ignore
- * @since 1.1.0
- */
-export { isArguments, isArray, isArrayBuffer, isBlob, isBoolean, isDate, isError, isFunction, isObject, isNull, isNaN, isNumber, isRegExp, isString, isSymbol, isMap, isWeakMap, isSet, isWeakSet, isUndefined };

package/esm/utils/type/isArguments.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为Arguments
- *
- * @static
- * @alias module:Type.isArguments
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Arguments
- * @example
- *
- * isArguments(function() { return arguments }())
- * // => true
- *
- * isArguments([1, 2, 3])
- * // => false
- */
-function isArguments(value) {
-  return isType(value, 'Arguments');
-}
-export default isArguments;

package/esm/utils/type/isArray.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为Array
- *
- * @static
- * @alias module:Type.isArray
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Array
- * @example
- *
- * isArray([])
- * // => true
- *
- * isArray(1)
- * // => false
- */
-function isArray(value) {
-  return Array.isArray(value) || isType(value, 'Array');
-}
-export default isArray;

package/esm/utils/type/isArrayBuffer.js

@@ -1,25 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为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
- */
-function isArrayBuffer(value) {
-  return isType(value, 'ArrayBuffer');
-}
-export default isArrayBuffer;

package/esm/utils/type/isBoolean.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为Boolean
- *
- * @static
- * @alias module:Type.isBoolean
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Boolean
- * @example
- *
- * isBoolean(false)
- * // => true
- *
- * isBoolean(null)
- * // => false
- */
-function isBoolean(value) {
-  return value === true || value === false || isType(value, 'Boolean');
-}
-export default isBoolean;

package/esm/utils/type/isDate.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为Date
- *
- * @static
- * @alias module:Type.isDate
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Date
- * @example
- *
- * isDate(new Date)
- * // => true
- *
- * isDate('Mon April 23 2012')
- * // => false
- */
-function isDate(value) {
-  return isType(value, 'Date');
-}
-export default isDate;

package/esm/utils/type/isError.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError|DOMException
- *
- * @static
- * @alias module:Type.isError
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError|DOMException
- * @example
- *
- * isError(new Error)
- * // => true
- *
- * isError(Error)
- * // => false
- */
-function isError(value) {
-  return isType(value, 'Error') || isType(value, 'DOMException');
-}
-export default isError;

package/esm/utils/type/isFunction.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为Function|AsyncFunction|GeneratorFunction|Proxy
- *
- * @static
- * @alias module:Type.isFunction
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Function|AsyncFunction|GeneratorFunction|Proxy
- * @example
- *
- * isFunction(()=>{}))
- * // => true
- *
- * isFunction(/abc/)
- * // => false
- */
-function isFunction(value) {
-  return isType(value, 'Function') || isType(value, 'AsyncFunction') || isType(value, 'GeneratorFunction') || isType(value, 'Proxy');
-}
-export default isFunction;

package/esm/utils/type/isMap.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为Map
- *
- * @static
- * @alias module:Type.isMap
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Map
- * @example
- *
- * isMap(new Map)
- * // => true
- *
- * isMap(new WeakMap)
- * // => false
- */
-function isMap(value) {
-  return isType(value, 'Map');
-}
-export default isMap;

package/esm/utils/type/isRegExp.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为RegExp
- *
- * @static
- * @alias module:Type.isRegExp
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为RegExp
- * @example
- *
- * isRegExp(/abc/)
- * // => true
- *
- * isRegExp('/abc/')
- * // => false
- */
-function isRegExp(value) {
-  return isType(value, 'RegExp');
-}
-export default isRegExp;

package/esm/utils/type/isSet.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为Set
- *
- * @static
- * @alias module:Type.isSet
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为Set
- * @example
- *
- * isSet(new Set)
- * // => true
- *
- * isSet(new WeakSet)
- * // => false
- */
-function isSet(value) {
-  return isType(value, 'Set');
-}
-export default isSet;

package/esm/utils/type/isWeakMap.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为WeakMap
- *
- * @static
- * @alias module:Type.isWeakMap
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为WeakMap
- * @example
- *
- * isWeakMap(new WeakMap)
- * // => true
- *
- * isWeakMap(new Map)
- * // => false
- */
-function isWeakMap(value) {
-  return isType(value, 'WeakMap');
-}
-export default isWeakMap;

package/esm/utils/type/isWeakSet.js

@@ -1,22 +0,0 @@
-import isType from './isType';
-
-/**
- * 检查值是否为WeakSet
- *
- * @static
- * @alias module:Type.isWeakSet
- * @since 1.1.0
- * @param {*} value 检查值
- * @returns {boolean} 是否为WeakSet
- * @example
- *
- * isWeakSet(new WeakSet)
- * // => true
- *
- * isWeakSet(new Set)
- * // => false
- */
-function isWeakSet(value) {
-  return isType(value, 'WeakSet');
-}
-export default isWeakSet;

package/lib/interface.doc.js

@@ -1,127 +0,0 @@
-"use strict";
-
-/* eslint-disable no-unused-vars */
-// 该文件用于 jsdoc 生成文件。因为一些 typescript 语法， jsdoc 不支持，导致生成文档报错。
-
-/**
- * 转换字段名，返回一个转换字段后的值，不改变原值。
- * 
- * @static
- * @alias module:Tree.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) {}
-
-/**
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest|XMLHttpRequest}
- * @typedef {Object} AjaxOptions ajax配置项
- * @property {string} [method="get"] 创建请求时使用的方法
- * @property {*} [data=null] 请求体被发送的数据
- * @property {object} [headers] 自定义请求头
- * @property {string} [responseType] 响应类型
- * @property {number} [timeout] 请求超时的毫秒数
- * @property {boolean} [withCredentials=false] 跨域请求时是否需要使用凭证
- * @property {boolean} [async=true] 是否异步执行操作
- * @property {string|null} [user=null] 用户名，用于认证用途
- * @property {string|null} [password=null] 密码，用于认证用途
- * @property {function} [onLoadStart] 接收到响应数据时触发
- * @property {function} [onProgress] 请求接收到更多数据时，周期性地触发
- * @property {function} [onAbort] 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时
- * @property {function} [onTimeout] 在预设时间内没有接收到响应时触发
- * @property {function} [onError] 当 request 遭遇错误时触发
- * @property {function} [onLoad] 请求成功完成时触发
- * @property {function} [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<object>} XHR 事件对象
- * @example
- * ajax('/somefile').then(res=>{
- *   // do something
- * });
- * 
- * ajax('/api', { method: 'post' }).then(res=>{
- *   // do something
- * });
- */
-function ajax(url, options) {}
-
-/**
- * @callback TransformRequest
- * @param {AjaxOptions} options ajax 配置项
- * @returns {AjaxOptions | Promise<AjaxOptions>}
- */
-
-/**
- * @callback TransformResponse
- * @param {Blob} res 响应的Blob对象。如果你通过 transformRequest 修改了 responseType ，该参数将是该类型响应值。
- * @returns {Blob | Promise<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/多用途互聯網郵件擴展|MIME}
- * @see {@link https://9ykc9s.csb.app/|在线示例}
- * @param {string|Blob|TypedArray} 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');
- * 
- */
-function download(data, fileName, options) {}

package/lib/interface.type.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});