a-js-tools 0.6.2 → 0.7.0

package/README.md

@@ -21,6 +21,7 @@ npm install --save a-js-tools
 - `isBrowser` 是否为浏览器环境
 - `isNode` 是否为 Node 环境
 - `createConstructor` 构造构造函数
+- `sleep` 你的线程太累了，让它丫的睡一会吧
 
 ## class 名称转化
 

package/cjs/index.cjs

@@ -9,6 +9,7 @@ var autoEscapedRegExp = require('./src/regexp/autoEscapedRegExp.cjs');
 var isNode = require('./src/isNode.cjs');
 var createConstructor = require('./src/object/createConstructor.cjs');
 var index = require('./src/array/index.cjs');
+var sleep = require('./src/sleep.cjs');
 var intersection = require('./src/array/intersection.cjs');
 var union = require('./src/array/union.cjs');
 var difference = require('./src/array/difference.cjs');
@@ -29,6 +30,7 @@ exports.isBrowser = isNode.isBrowser;
 exports.isNode = isNode.isNode;
 exports.createConstructor = createConstructor.createConstructor;
 exports.enArr = index.enArr;
+exports.sleep = sleep.sleep;
 exports.intersection = intersection.intersection;
 exports.union = union.union;
 exports.difference = difference.difference;

package/cjs/src/sleep.cjs

@@ -0,0 +1,36 @@
+'use strict';
+
+/**
+ *
+ * ## 线程休息
+ *
+ * 但从调用到执行完毕总是与期望的时间并不相吻合，除非执行是线型的（也不保证时间的严格性）
+ *
+ * - 宏任务：整体代码、setTimeout、DOM 事件回调、requestAnimationFrame、setImmediate、setInterval、I/O操作、UI渲染等
+ * - 微任务：Promise的then/catch/finally、process.nextTick（Node.js）、MutationObserver、queueMicrotask（显示添加微任务）等
+ *
+ * <span style="color:#ff0;">*Node.js中的process.nextTick优先级高于其他微任务*</span>
+ *
+ * @param delay 睡觉时长（机器时间，毫秒为单位）
+ * @returns 🈳
+ * @example
+ *
+ * ```ts
+ * import { sleep } from 'a-js-tools';
+ *
+ * console.log(Date.now()); // 1748058118471
+ * await sleep(1000);
+ * console.log(Date.now()); // 1748058119473
+ *
+ * ```
+ *
+ */
+async function sleep(delay = 1000) {
+    if (!isFinite(delay) || delay < 0)
+        throw new TypeError('delay 应该是一个正常的数值');
+    if (delay === 0)
+        return Promise.resolve();
+    return new Promise(resolve => setTimeout(resolve, delay));
+}
+
+exports.sleep = sleep;

package/mjs/index.mjs

@@ -7,6 +7,7 @@ export { autoEscapedRegExp } from './src/regexp/autoEscapedRegExp.mjs';
 export { isBrowser, isNode } from './src/isNode.mjs';
 export { createConstructor } from './src/object/createConstructor.mjs';
 export { enArr } from './src/array/index.mjs';
+export { sleep } from './src/sleep.mjs';
 export { intersection } from './src/array/intersection.mjs';
 export { union } from './src/array/union.mjs';
 export { difference } from './src/array/difference.mjs';

package/mjs/src/sleep.mjs

@@ -0,0 +1,34 @@
+/**
+ *
+ * ## 线程休息
+ *
+ * 但从调用到执行完毕总是与期望的时间并不相吻合，除非执行是线型的（也不保证时间的严格性）
+ *
+ * - 宏任务：整体代码、setTimeout、DOM 事件回调、requestAnimationFrame、setImmediate、setInterval、I/O操作、UI渲染等
+ * - 微任务：Promise的then/catch/finally、process.nextTick（Node.js）、MutationObserver、queueMicrotask（显示添加微任务）等
+ *
+ * <span style="color:#ff0;">*Node.js中的process.nextTick优先级高于其他微任务*</span>
+ *
+ * @param delay 睡觉时长（机器时间，毫秒为单位）
+ * @returns 🈳
+ * @example
+ *
+ * ```ts
+ * import { sleep } from 'a-js-tools';
+ *
+ * console.log(Date.now()); // 1748058118471
+ * await sleep(1000);
+ * console.log(Date.now()); // 1748058119473
+ *
+ * ```
+ *
+ */
+async function sleep(delay = 1000) {
+    if (!isFinite(delay) || delay < 0)
+        throw new TypeError('delay 应该是一个正常的数值');
+    if (delay === 0)
+        return Promise.resolve();
+    return new Promise(resolve => setTimeout(resolve, delay));
+}
+
+export { sleep };

package/package.json

@@ -1,6 +1,6 @@
 {
   "type": "module",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "name": "a-js-tools",
   "description": "一点点 🤏  js 函数",
   "license": "MIT",

package/types/index.d.ts

@@ -6,3 +6,4 @@ export { isBrowser, isNode } from './src/isNode';
 export { createConstructor } from './src/object/createConstructor';
 export type { CreateConstructor } from './src/object/createConstructor';
 export { intersection, enArr, union, difference, symmetricDifference, } from './src/array/';
+export { sleep } from './src/sleep';

package/types/src/sleep.d.ts

@@ -0,0 +1,26 @@
+/**
+ *
+ * ## 线程休息
+ *
+ * 但从调用到执行完毕总是与期望的时间并不相吻合，除非执行是线型的（也不保证时间的严格性）
+ *
+ * - 宏任务：整体代码、setTimeout、DOM 事件回调、requestAnimationFrame、setImmediate、setInterval、I/O操作、UI渲染等
+ * - 微任务：Promise的then/catch/finally、process.nextTick（Node.js）、MutationObserver、queueMicrotask（显示添加微任务）等
+ *
+ * <span style="color:#ff0;">*Node.js中的process.nextTick优先级高于其他微任务*</span>
+ *
+ * @param delay 睡觉时长（机器时间，毫秒为单位）
+ * @returns 🈳
+ * @example
+ *
+ * ```ts
+ * import { sleep } from 'a-js-tools';
+ *
+ * console.log(Date.now()); // 1748058118471
+ * await sleep(1000);
+ * console.log(Date.now()); // 1748058119473
+ *
+ * ```
+ *
+ */
+export declare function sleep(delay?: number): Promise<void>;