util-helpers 4.15.3 → 4.16.0

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/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: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) {}
-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: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) {}
-var _default = transformFieldNames;
-exports["default"] = _default;