a-js-tools 1.0.4 → 2.0.0-alpha.0

package/index.d.ts

@@ -1,7 +1,7 @@
 import { CreateConstructor, createConstructor } from 'src/object/createConstructor';
 export { toLowerCamelCase, toSplitCase, getRandomFloat, getRandomInt, getRandomString, } from './src/index';
 export { throttle, debounce } from './src/performance';
-export type { DebounceAndThrottleReturnType } from './src/performance';
+export type { DebounceAndThrottleReturnType, debounce_throttle_options, } from './src/performance';
 export { escapeRegExp, autoEscapedRegExp } from './src/regexp';
 export { isBrowser, isNode } from './src/isNode';
 export { intersection, enArr, union, difference, symmetricDifference, } from './src/array/';

package/package.json

@@ -1,6 +1,6 @@
 {
   "type": "module",
-  "version": "1.0.4",
+  "version": "2.0.0-alpha.0",
   "name": "a-js-tools",
   "description": "一点点 🤏  js 函数",
   "license": "MIT",

package/src/array/difference.cjs

@@ -34,12 +34,10 @@ var aTypeOfJs = require('a-type-of-js');
  *
  */
 function difference(a, b) {
-    if (!aTypeOfJs.isArray(a) || !aTypeOfJs.isArray(b)) {
+    if ([a, b].some(e => !aTypeOfJs.isArray(e)))
         throw new TypeError('参数需为数组');
-    }
-    if (a.length === 0 || b.length === 0) {
+    if ([a, b].some(e => aTypeOfJs.isEmptyArray(e)))
         return a;
-    }
     /**  获取两个数组中长度较小的  */
     // 参数有顺序要求
     // const [shorter, longer] = a.length > b.length ? [b, a] : [a, b];

package/src/array/difference.mjs

@@ -1,4 +1,4 @@
-import { isArray } from 'a-type-of-js';
+import { isArray, isEmptyArray } from 'a-type-of-js';
 
 /**
  *  求给出的两个数组的差值（A - B）
@@ -32,12 +32,10 @@ import { isArray } from 'a-type-of-js';
  *
  */
 function difference(a, b) {
-    if (!isArray(a) || !isArray(b)) {
+    if ([a, b].some(e => !isArray(e)))
         throw new TypeError('参数需为数组');
-    }
-    if (a.length === 0 || b.length === 0) {
+    if ([a, b].some(e => isEmptyArray(e)))
         return a;
-    }
     /**  获取两个数组中长度较小的  */
     // 参数有顺序要求
     // const [shorter, longer] = a.length > b.length ? [b, a] : [a, b];

package/src/array/intersection.cjs

@@ -24,13 +24,11 @@ var aTypeOfJs = require('a-type-of-js');
  *
  */
 function intersection(a, b) {
-    if (!aTypeOfJs.isArray(a) || !aTypeOfJs.isArray(b)) {
+    if (!aTypeOfJs.isArray(a) || !aTypeOfJs.isArray(b))
         throw new TypeError('参数必须是数组类型数据');
-    }
     // 任意数组为空，则返回空数组
-    if (a.length === 0 || b.length === 0) {
+    if ([a, b].some(e => aTypeOfJs.isEmptyArray(e)))
         return [];
-    }
     /**
      * 在实际运算中， new Set() 的 开销为 O(n) ,filter 的开销也为 O(n)
      *

package/src/array/intersection.mjs

@@ -1,4 +1,4 @@
-import { isArray } from 'a-type-of-js';
+import { isArray, isEmptyArray } from 'a-type-of-js';
 
 /**
  *
@@ -22,13 +22,11 @@ import { isArray } from 'a-type-of-js';
  *
  */
 function intersection(a, b) {
-    if (!isArray(a) || !isArray(b)) {
+    if (!isArray(a) || !isArray(b))
         throw new TypeError('参数必须是数组类型数据');
-    }
     // 任意数组为空，则返回空数组
-    if (a.length === 0 || b.length === 0) {
+    if ([a, b].some(e => isEmptyArray(e)))
         return [];
-    }
     /**
      * 在实际运算中， new Set() 的 开销为 O(n) ,filter 的开销也为 O(n)
      *

package/src/array/symmetricDifference.cjs

@@ -39,10 +39,10 @@ function symmetricDifference(a, b) {
     if (!aTypeOfJs.isArray(a) || !aTypeOfJs.isArray(b)) {
         throw new TypeError('参数必须是数组');
     }
-    if (a.length === 0) {
+    if (aTypeOfJs.isEmptyArray(a)) {
         return [...b];
     }
-    if (b.length === 0) {
+    if (aTypeOfJs.isEmptyArray(b)) {
         return [...a];
     }
     return [...difference.difference(a, b), ...difference.difference(b, a)];

package/src/array/symmetricDifference.mjs

@@ -1,4 +1,4 @@
-import { isArray } from 'a-type-of-js';
+import { isArray, isEmptyArray } from 'a-type-of-js';
 import { difference } from './difference.mjs';
 
 /**
@@ -37,10 +37,10 @@ function symmetricDifference(a, b) {
     if (!isArray(a) || !isArray(b)) {
         throw new TypeError('参数必须是数组');
     }
-    if (a.length === 0) {
+    if (isEmptyArray(a)) {
         return [...b];
     }
-    if (b.length === 0) {
+    if (isEmptyArray(b)) {
         return [...a];
     }
     return [...difference(a, b), ...difference(b, a)];

package/src/array/union.cjs

@@ -44,7 +44,7 @@ var aTypeOfJs = require('a-type-of-js');
  *
  */
 function union(...arrays) {
-    if (arrays.length === 0) {
+    if (aTypeOfJs.isEmptyArray(arrays)) {
         return [];
     }
     if (arrays.some(i => !aTypeOfJs.isArray(i))) {

package/src/array/union.mjs

@@ -1,4 +1,4 @@
-import { isArray } from 'a-type-of-js';
+import { isEmptyArray, isArray } from 'a-type-of-js';
 
 /**
  *
@@ -42,7 +42,7 @@ import { isArray } from 'a-type-of-js';
  *
  */
 function union(...arrays) {
-    if (arrays.length === 0) {
+    if (isEmptyArray(arrays)) {
         return [];
     }
     if (arrays.some(i => !isArray(i))) {

package/src/getRandomString.cjs

@@ -104,7 +104,7 @@ function getRandomString(options) {
         const str1Length = str1.length, str2Length = str2.length;
         const maxLength = Math.max(str1Length, str2Length);
         for (let i = 0; i < maxLength; i++) {
-            if (i < str1Length && str2[i] !== undefined) {
+            if (i < str1Length && !aTypeOfJs.isUndefined(str2[i])) {
                 str1[i] += str2[i];
             }
             else if (i < str2Length) {

package/src/getRandomString.mjs

@@ -1,4 +1,4 @@
-import { isPlainObject, isNumber, isNaN } from 'a-type-of-js';
+import { isPlainObject, isNumber, isNaN, isUndefined } from 'a-type-of-js';
 import { isBrowser } from './isNode.mjs';
 
 /**
@@ -102,7 +102,7 @@ function getRandomString(options) {
         const str1Length = str1.length, str2Length = str2.length;
         const maxLength = Math.max(str1Length, str2Length);
         for (let i = 0; i < maxLength; i++) {
-            if (i < str1Length && str2[i] !== undefined) {
+            if (i < str1Length && !isUndefined(str2[i])) {
                 str1[i] += str2[i];
             }
             else if (i < str2Length) {

package/src/performance.cjs

@@ -1,5 +1,7 @@
 'use strict';
 
+var aTypeOfJs = require('a-type-of-js');
+
 /**
  * 防抖和节流
  *
@@ -11,8 +13,7 @@
  *
  * 防抖
  *
- * @param   callback 回调函数
- * @param   delay    延迟时间（毫秒），默认 200 (ms)
+ * @param options 使用参数
  * @returns   返回的闭包函数
  * @example
  *
@@ -25,13 +26,21 @@
  * }
  *
  */
-function debounce(callback, delay = 200) {
-    if (typeof callback !== 'function') {
-        throw new TypeError('callback must be a function');
+function debounce(options) {
+    if (aTypeOfJs.isFunction(options)) {
+        options = {
+            callback: options,
+            delay: 200,
+            this: null,
+        };
     }
-    if (!isFinite(delay) || delay < 0)
+    if (!aTypeOfJs.isPlainObject(options) || !aTypeOfJs.isFunction(options.callback))
+        throw new TypeError('参数类型有误');
+    if (aTypeOfJs.isUndefined(options.delay))
+        options.delay = 200;
+    if (!isFinite(options.delay) || options.delay < 0)
         // 强制转换非数值
-        delay = 200;
+        options.delay = 200;
     /**  定时器返回的 id  */
     let timeoutId;
     const clear = () => {
@@ -44,12 +53,12 @@ function debounce(callback, delay = 200) {
         clear();
         timeoutId = setTimeout(() => {
             try {
-                Reflect.apply(callback, null, args);
+                Reflect.apply(options.callback, options.this ?? null, args);
             }
             catch (error) {
                 console.log('Debounce callback throw an error', error);
             }
-        }, Math.max(delay, 5));
+        }, Math.max(options.delay ?? 5, 5));
     };
     result.cancel = () => {
         clear();
@@ -59,14 +68,24 @@ function debounce(callback, delay = 200) {
 /**
  *   节流
  *
- * @param callback   回调函数
- * @param delay      延迟时间（毫秒），默认 200 (ms)
+ * @param options 使用的参数值
  * @returns   返回的闭包函数
  */
-function throttle(callback, delay = 200) {
-    // 强制转换非数值
-    if (!isFinite(delay) || (isFinite(delay) && delay < 4))
-        delay = 200;
+function throttle(options) {
+    if (aTypeOfJs.isFunction(options)) {
+        options = {
+            callback: options,
+            delay: 200,
+            this: null,
+        };
+    }
+    if (!aTypeOfJs.isPlainObject(options) || !aTypeOfJs.isFunction(options.callback))
+        throw new TypeError('参数类型有误');
+    if (aTypeOfJs.isUndefined(options.delay))
+        options.delay = 200;
+    if (!isFinite(options.delay) || options.delay < 0)
+        // 强制转换非数值
+        options.delay = 200;
     /**  延迟控制插销   */
     let inThrottle = false;
     /**  延迟控制   */
@@ -75,22 +94,22 @@ function throttle(callback, delay = 200) {
         if (inThrottle)
             return;
         try {
-            Reflect.apply(callback, null, args);
+            Reflect.apply(options.callback, options.this ?? null, args);
         }
         catch (error) {
             console.error('Throttle callback throw an error', error);
         }
         inThrottle = true;
-        if (timeoutId !== null) {
+        if (!aTypeOfJs.isNull(timeoutId)) {
             clearTimeout(timeoutId);
         }
         timeoutId = setTimeout(() => {
             inThrottle = false;
             timeoutId = null;
-        }, delay);
+        }, Math.max(options.delay ?? 5, 5));
     };
     throttled.cancel = () => {
-        if (timeoutId !== null) {
+        if (!aTypeOfJs.isNull(timeoutId)) {
             clearTimeout(timeoutId);
         }
         inThrottle = false;

package/src/performance.d.ts

@@ -15,12 +15,20 @@ export interface DebounceAndThrottleReturnType<F extends Callback> {
     (...args: Parameters<F>): void;
     cancel(): void;
 }
+/**  参数类型  */
+export type debounce_throttle_options<T extends (...args: unknown[]) => void> = T | {
+    /**  回调函数  */
+    callback: T;
+    /**  使用的延迟时间，缺省值为 200ms  */
+    delay?: number;
+    /**  使用的 this  */
+    this?: null | unknown;
+};
 /**
  *
  * 防抖
  *
- * @param   callback 回调函数
- * @param   delay    延迟时间（毫秒），默认 200 (ms)
+ * @param options 使用参数
  * @returns   返回的闭包函数
  * @example
  *
@@ -33,13 +41,12 @@ export interface DebounceAndThrottleReturnType<F extends Callback> {
  * }
  *
  */
-export declare function debounce<F extends (...args: unknown[]) => void>(callback: F, delay?: number): DebounceAndThrottleReturnType<F>;
+export declare function debounce<F extends (...args: unknown[]) => void>(options: debounce_throttle_options<F>): DebounceAndThrottleReturnType<F>;
 /**
  *   节流
  *
- * @param callback   回调函数
- * @param delay      延迟时间（毫秒），默认 200 (ms)
+ * @param options 使用的参数值
  * @returns   返回的闭包函数
  */
-export declare function throttle<F extends (...args: unknown[]) => void>(callback: F, delay?: number): DebounceAndThrottleReturnType<F>;
+export declare function throttle<F extends (...args: unknown[]) => void>(options: debounce_throttle_options<F>): DebounceAndThrottleReturnType<F>;
 export {};

package/src/performance.mjs

@@ -1,3 +1,5 @@
+import { isFunction, isPlainObject, isUndefined, isNull } from 'a-type-of-js';
+
 /**
  * 防抖和节流
  *
@@ -9,8 +11,7 @@
  *
  * 防抖
  *
- * @param   callback 回调函数
- * @param   delay    延迟时间（毫秒），默认 200 (ms)
+ * @param options 使用参数
  * @returns   返回的闭包函数
  * @example
  *
@@ -23,13 +24,21 @@
  * }
  *
  */
-function debounce(callback, delay = 200) {
-    if (typeof callback !== 'function') {
-        throw new TypeError('callback must be a function');
+function debounce(options) {
+    if (isFunction(options)) {
+        options = {
+            callback: options,
+            delay: 200,
+            this: null,
+        };
     }
-    if (!isFinite(delay) || delay < 0)
+    if (!isPlainObject(options) || !isFunction(options.callback))
+        throw new TypeError('参数类型有误');
+    if (isUndefined(options.delay))
+        options.delay = 200;
+    if (!isFinite(options.delay) || options.delay < 0)
         // 强制转换非数值
-        delay = 200;
+        options.delay = 200;
     /**  定时器返回的 id  */
     let timeoutId;
     const clear = () => {
@@ -42,12 +51,12 @@ function debounce(callback, delay = 200) {
         clear();
         timeoutId = setTimeout(() => {
             try {
-                Reflect.apply(callback, null, args);
+                Reflect.apply(options.callback, options.this ?? null, args);
             }
             catch (error) {
                 console.log('Debounce callback throw an error', error);
             }
-        }, Math.max(delay, 5));
+        }, Math.max(options.delay ?? 5, 5));
     };
     result.cancel = () => {
         clear();
@@ -57,14 +66,24 @@ function debounce(callback, delay = 200) {
 /**
  *   节流
  *
- * @param callback   回调函数
- * @param delay      延迟时间（毫秒），默认 200 (ms)
+ * @param options 使用的参数值
  * @returns   返回的闭包函数
  */
-function throttle(callback, delay = 200) {
-    // 强制转换非数值
-    if (!isFinite(delay) || (isFinite(delay) && delay < 4))
-        delay = 200;
+function throttle(options) {
+    if (isFunction(options)) {
+        options = {
+            callback: options,
+            delay: 200,
+            this: null,
+        };
+    }
+    if (!isPlainObject(options) || !isFunction(options.callback))
+        throw new TypeError('参数类型有误');
+    if (isUndefined(options.delay))
+        options.delay = 200;
+    if (!isFinite(options.delay) || options.delay < 0)
+        // 强制转换非数值
+        options.delay = 200;
     /**  延迟控制插销   */
     let inThrottle = false;
     /**  延迟控制   */
@@ -73,22 +92,22 @@ function throttle(callback, delay = 200) {
         if (inThrottle)
             return;
         try {
-            Reflect.apply(callback, null, args);
+            Reflect.apply(options.callback, options.this ?? null, args);
         }
         catch (error) {
             console.error('Throttle callback throw an error', error);
         }
         inThrottle = true;
-        if (timeoutId !== null) {
+        if (!isNull(timeoutId)) {
             clearTimeout(timeoutId);
         }
         timeoutId = setTimeout(() => {
             inThrottle = false;
             timeoutId = null;
-        }, delay);
+        }, Math.max(options.delay ?? 5, 5));
     };
     throttled.cancel = () => {
-        if (timeoutId !== null) {
+        if (!isNull(timeoutId)) {
             clearTimeout(timeoutId);
         }
         inThrottle = false;

package/src/sleep.cjs

@@ -1,5 +1,7 @@
 'use strict';
 
+var aTypeOfJs = require('a-type-of-js');
+
 /**
  *
  * ## 线程休息
@@ -28,7 +30,7 @@
 async function sleep(delay = 1000) {
     if (!isFinite(delay) || delay < 0)
         throw new TypeError('delay 应该是一个正常的数值');
-    if (delay === 0)
+    if (aTypeOfJs.isZero(delay))
         return Promise.resolve();
     return new Promise(resolve => setTimeout(resolve, delay));
 }

package/src/sleep.mjs

@@ -1,3 +1,5 @@
+import { isZero } from 'a-type-of-js';
+
 /**
  *
  * ## 线程休息
@@ -26,7 +28,7 @@
 async function sleep(delay = 1000) {
     if (!isFinite(delay) || delay < 0)
         throw new TypeError('delay 应该是一个正常的数值');
-    if (delay === 0)
+    if (isZero(delay))
         return Promise.resolve();
     return new Promise(resolve => setTimeout(resolve, delay));
 }