build(pkg:async): added new namespace Async

Author: fenying

CHANGES.md

@@ -3,6 +3,10 @@
 ## v1.2.0
 
 - feat(pkg:network): added API Network.isValidIPv4Address
+- feat(pkg:async): added utility class `FiberController`
+- feat(pkg:async): added utility class `PromiseController`
+- feat(pkg:async): added utility class `BackgroundRunner`
+- feat(pkg:async): added API `Async.withTimeout`
 
 ## v1.1.1
 

README.md

@@ -25,6 +25,7 @@ The [bundle package `@litert/utils`](https://www.npmjs.com/package/@litert/utils
     - [@litert/utils-ts-types](https://www.npmjs.com/package/@litert/utils-ts-types)
 
 - `Namespace Array` (Sub-package: [@litert/utils-array](https://www.npmjs.com/package/@litert/utils-array))
+- `Namespace Async` (Sub-package: [@litert/utils-async](https://www.npmjs.com/package/@litert/utils-async))
 - `Namespace Network` (Sub-package: [@litert/utils-network](https://www.npmjs.com/package/@litert/utils-network))
 - `Namespace Number` (Sub-package: [@litert/utils-number](https://www.npmjs.com/package/@litert/utils-number))
 - `Namespace Object` (Sub-package: [@litert/utils-object](https://www.npmjs.com/package/@litert/utils-object))
@@ -39,12 +40,13 @@ npm i @litert/utils --save
 ## Documentation
 
 - [Array](https://litert.org/projects/utils.js/api-docs/array/)
+- [Async](https://litert.org/projects/utils.js/api-docs/async/)
 - [Flow Control](https://litert.org/projects/utils.js/api-docs/flow-control/)
 - [Network](https://litert.org/projects/utils.js/api-docs/network/)
 - [Number](https://litert.org/projects/utils.js/api-docs/number/)
 - [Object](https://litert.org/projects/utils.js/api-docs/object/)
 - [String](https://litert.org/projects/utils.js/api-docs/string/)
-- [Typescript Types](https://litert.org/projects/utils.js/api-docs/ts-types/)
+- [TypeScript Utility Types](https://litert.org/projects/utils.js/api-docs/ts-types/)
 
 ## License
 

commitlint.config.js

@@ -11,6 +11,7 @@ module.exports = {
         ]],
         'scope-enum': [2, 'always', [
             'pkg:array',
+            'pkg:async',
             'pkg:flow-control',
             'pkg:network',
             'pkg:number',

packages/bundle/package.json

@@ -22,13 +22,14 @@
   "license": "Apache-2.0",
   "private": false,
   "dependencies": {
-    "@litert/utils-array": "-",
     "@litert/utils-flow-control": "-",
     "@litert/utils-number": "-",
     "@litert/utils-object": "-",
     "@litert/utils-string": "-",
     "@litert/utils-ts-types": "-",
-    "@litert/utils-network": "-"
+    "@litert/utils-network": "-",
+    "@litert/utils-array": "-",
+    "@litert/utils-async": "-"
   },
   "keywords": [
     "utility",

packages/bundle/src/index.ts

@@ -15,6 +15,7 @@
  */
 
 export * as Array from '@litert/utils-array';
+export * as Async from '@litert/utils-async';
 export * as Network from '@litert/utils-network';
 export * as Number from '@litert/utils-number';
 export * as Object from '@litert/utils-object';

packages/bundle/tsconfig.json

@@ -7,6 +7,7 @@
   },
   "references": [
     { "path": "../partials/array" },
+    { "path": "../partials/async" },
     { "path": "../partials/flow-control" },
     { "path": "../partials/number" },
     { "path": "../partials/object" },

packages/partials/async/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+lib/

packages/partials/async/.npmignore

@@ -0,0 +1,16 @@
+/.git/
+/.vscode/
+/.eslintrc
+/.eslintignore
+/.npmrc
+/.npmignore
+/.gitignore
+/tsconfig.json
+/tslint.json
+/node_modules/
+*.test.ts
+*.test.d.ts
+*.test.d.ts.map
+*.test.js
+*.test.js.map
+tsconfig.tsbuildinfo

packages/partials/async/README.md

@@ -0,0 +1,29 @@
+# LiteRT/Utils - Async
+
+[![Strict TypeScript Checked](https://badgen.net/badge/TS/Strict "Strict TypeScript Checked")](https://www.typescriptlang.org)
+[![npm version](https://img.shields.io/npm/v/@litert/utils-async.svg?colorB=brightgreen)](https://www.npmjs.com/package/@litert/utils-async "Stable Version")
+[![License](https://img.shields.io/npm/l/@litert/utils-async.svg?maxAge=2592000?style=plastic)](https://github.com/litert/utils.js/blob/master/LICENSE)
+[![node](https://img.shields.io/node/v/@litert/utils-async.svg?colorB=brightgreen)](https://nodejs.org/dist/latest-v8.x/)
+[![GitHub issues](https://img.shields.io/github/issues/litert/utils.js.svg)](https://github.com/litert/utils.js/issues)
+[![GitHub Releases](https://img.shields.io/github/release/litert/utils.js.svg)](https://github.com/litert/utils.js/releases "Stable Release")
+
+The utility functions/classes/constants about asynchronous operations for JavaScript/TypeScript.
+
+## Requirement
+
+- TypeScript v5.0.0 (or newer)
+- Node.js v18.0.0 (or newer)
+
+## Installation
+
+```sh
+npm i @litert/utils-async --save
+```
+
+## Documentation
+
+- [en-US](https://litert.org/projects/utils.js/api-docs/async/)
+
+## License
+
+This library is published under [Apache-2.0](https://github.com/litert/utils.js/blob/master/LICENSE) license.

packages/partials/async/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@litert/utils-async",
+  "version": "0.1.0",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "typings": "lib/index.d.ts",
+  "description": "The utility functions/classes/constants about asynchronous operations for JavaScript/TypeScript.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/litert/utils.js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/litert/utils.js/issues"
+  },
+  "homepage": "https://github.com/litert/utils.js#readme",
+  "scripts": {
+    "ottoia:clean": "rm -rf lib tsconfig.tsbuildinfo",
+    "ottoia:prepublish": "cp ../../../LICENSE ./",
+    "ottoia:postpublish": "rm LICENSE",
+    "prepublishOnly": "echo \"Please use ottoia publishing this package!\"; exit 1;"
+  },
+  "license": "Apache-2.0",
+  "private": false,
+  "dependencies": {
+    "@litert/utils-ts-types": "-"
+  },
+  "keywords": [
+    "utility",
+    "litert",
+    "async",
+    "asynchronous",
+    "helper"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {},
+  "peerDependencies": {},
+  "ottoia:alias": "partials.async",
+  "access": "public"
+}