@alwatr/async-queue 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.0.0 (2024-01-03)
+
+### Bug Fixes
+
+* **async-queue:** remove wait deps ([83b2e11](https://github.com/Alwatr/nanolib/commit/83b2e115a939b90049c4af8d1cd6c4ebee282bf8)) by @njfamirm
+
+### Features
+
+* **async-queue:** A simple async queue like mutex and semaphore methodology for javascript and typescript. ([e753ff2](https://github.com/Alwatr/nanolib/commit/e753ff29cf53e0e6bcdd9661666ee60300960db3)) by @AliMD
+* **async-queue:** add isRunning ([2e54a0a](https://github.com/Alwatr/nanolib/commit/2e54a0a5200ccbfcc64e443728eb6d16513b4296)) by @njfamirm

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 S. Ali Mihandoost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+# Async Queue
+
+A queue that executes async tasks in order like mutex and semaphore methodology for javascript and typescript.
+
+## Installation
+
+```bash
+yarn add @alwatr/async-queue
+```
+
+## Usage
+
+```typescript
+import {AsyncQueue} from '@alwatr/async-queue';
+import {waitForTimeout} from '@alwatr/wait';
+
+const queue = new AsyncQueue();
+
+async function longTask(n) {
+  console.log('longTask(%s)', n);
+  await queue.push('longTaskId', async () => {
+    console.log('longTask %s start', n);
+    // Simulate a long task
+    await waitForTimeout(1000);
+  });
+  console.log('longTask %s end', n);
+}
+
+// run the tasks parallel
+longTask(1);
+longTask(2);
+longTask(3).then(() => console.log('longTask 3 resolved'));
+longTask(4);
+
+/*
+Output:
+
+  longTask(1)
+  longTask(2)
+  longTask(3)
+  longTask(4)
+  longTask 1 start
+  longTask 1 end
+  longTask 2 start
+  longTask 2 end
+  longTask 3 start
+  longTask 3 end
+  longTask 3 resolved
+  longTask 4 start
+  longTask 4 end
+
+*/
+```

package/dist/main.cjs

@@ -0,0 +1,3 @@
+/* @alwatr/async-queue v1.0.0 */
+"use strict";var s=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var h=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var l=(e,i,t)=>i in e?s(e,i,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[i]=t;var v=(e,i)=>{for(var t in i)s(e,t,{get:i[t],enumerable:!0})},f=(e,i,t,r)=>{if(i&&typeof i=="object"||typeof i=="function")for(let o of h(i))!c.call(e,o)&&o!==t&&s(e,o,{get:()=>i[o],enumerable:!(r=a(i,o))||r.enumerable});return e};var u=e=>f(s({},"__esModule",{value:!0}),e);var m=(e,i,t)=>(l(e,typeof i!="symbol"?i+"":i,t),t);var y={};v(y,{AsyncQueue:()=>n});module.exports=u(y);var p=require("@alwatr/flatomise"),n=class{constructor(){m(this,"i",{})}async push(i,t){let r=(0,p.newFlatomise)(),o=this.i[i];this.i[i]=r.promise;try{await o}catch{}return setTimeout(()=>{t().then(r.resolve,r.reject).then(()=>{this.i[i]===r.promise&&delete this.i[i]})},0),r.promise}isRunning(i){return this.i[i]!==void 0}};0&&(module.exports={AsyncQueue});
+//# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["import {newFlatomise} from '@alwatr/flatomise';\n\nimport type {Dictionary} from '@alwatr/type-helper';\n\n/**\n * A queue that executes async tasks in order like mutex and semaphore methodology\n *\n * @example\n * ```ts\n * const queue = new AsyncQueue();\n *\n * function longTask() {\n *   queue.push('longTaskId', async () => {\n *     // ...\n *   });\n * }\n * ```\n */\nexport class AsyncQueue {\n  /**\n   * A record of task IDs and their corresponding last queued task promises.\n   */\n  private queue__: Dictionary<Promise<void>> = {};\n\n  /**\n   * Push a async task to the queue.\n   *\n   * @param taskId task id\n   * @param task async task\n   * @returns A promise that resolves when the task is done.\n   *\n   * @example\n   * ```typescript\n   * const queue = new AsyncQueue();\n   *\n   * function longTask() {\n   *  queue.push('longTaskId', async () => {\n   *   // ...\n   * });\n   * ```\n   */\n  async push(taskId: string, task: () => Promise<void>): Promise<void> {\n    const flatomise = newFlatomise();\n\n    const previousTaskPromise = this.queue__[taskId];\n    this.queue__[taskId] = flatomise.promise;\n\n    try {\n      await previousTaskPromise;\n    }\n    catch (_e) {\n      // ignore\n    }\n\n    setTimeout(() => {\n      task().then(flatomise.resolve, flatomise.reject).then(() => {\n        if (this.queue__[taskId] === flatomise.promise) {\n          delete this.queue__[taskId];\n        }\n      });\n    }, 0);\n\n    return flatomise.promise;\n  }\n\n  /**\n   * Check if the task running in the queue.\n   *\n   * @param taskId task id\n   * @returns true if the task is running, otherwise false.\n   */\n  isRunning(taskId: string): boolean {\n    return this.queue__[taskId] !== undefined;\n  }\n}\n"],
+  "mappings": ";qjBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,gBAAAE,IAAA,eAAAC,EAAAH,GAAA,IAAAI,EAA2B,6BAkBdC,EAAN,KAAiB,CAAjB,cAILC,EAAA,KAAQC,IAAqC,CAAC,GAmB9C,MAAM,KAAKC,EAAgBC,EAA0C,CACnE,IAAMC,KAAY,gBAAa,EAEzBC,EAAsB,KAAKJ,EAAQC,CAAM,EAC/C,KAAKD,EAAQC,CAAM,EAAIE,EAAU,QAEjC,GAAI,CACF,MAAMC,CACR,MACW,CAEX,CAEA,kBAAW,IAAM,CACfF,EAAK,EAAE,KAAKC,EAAU,QAASA,EAAU,MAAM,EAAE,KAAK,IAAM,CACtD,KAAKH,EAAQC,CAAM,IAAME,EAAU,SACrC,OAAO,KAAKH,EAAQC,CAAM,CAE9B,CAAC,CACH,EAAG,CAAC,EAEGE,EAAU,OACnB,CAQA,UAAUF,EAAyB,CACjC,OAAO,KAAKD,EAAQC,CAAM,IAAM,MAClC,CACF",
+  "names": ["main_exports", "__export", "AsyncQueue", "__toCommonJS", "import_flatomise", "AsyncQueue", "__publicField", "queue__", "taskId", "task", "flatomise", "previousTaskPromise"]
+}

package/dist/main.d.ts

@@ -0,0 +1,46 @@
+/**
+ * A queue that executes async tasks in order like mutex and semaphore methodology
+ *
+ * @example
+ * ```ts
+ * const queue = new AsyncQueue();
+ *
+ * function longTask() {
+ *   queue.push('longTaskId', async () => {
+ *     // ...
+ *   });
+ * }
+ * ```
+ */
+export declare class AsyncQueue {
+    /**
+     * A record of task IDs and their corresponding last queued task promises.
+     */
+    private queue__;
+    /**
+     * Push a async task to the queue.
+     *
+     * @param taskId task id
+     * @param task async task
+     * @returns A promise that resolves when the task is done.
+     *
+     * @example
+     * ```typescript
+     * const queue = new AsyncQueue();
+     *
+     * function longTask() {
+     *  queue.push('longTaskId', async () => {
+     *   // ...
+     * });
+     * ```
+     */
+    push(taskId: string, task: () => Promise<void>): Promise<void>;
+    /**
+     * Check if the task running in the queue.
+     *
+     * @param taskId task id
+     * @returns true if the task is running, otherwise false.
+     */
+    isRunning(taskId: string): boolean;
+}
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,qBAAa,UAAU;IACrB;;OAEG;IACH,OAAO,CAAC,OAAO,CAAiC;IAEhD;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBpE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;CAGnC"}

package/dist/main.mjs

@@ -0,0 +1,3 @@
+/* @alwatr/async-queue v1.0.0 */
+var m=Object.defineProperty;var p=(t,i,e)=>i in t?m(t,i,{enumerable:!0,configurable:!0,writable:!0,value:e}):t[i]=e;var o=(t,i,e)=>(p(t,typeof i!="symbol"?i+"":i,e),e);import{newFlatomise as a}from"@alwatr/flatomise";var s=class{constructor(){o(this,"i",{})}async push(i,e){let r=a(),n=this.i[i];this.i[i]=r.promise;try{await n}catch{}return setTimeout(()=>{e().then(r.resolve,r.reject).then(()=>{this.i[i]===r.promise&&delete this.i[i]})},0),r.promise}isRunning(i){return this.i[i]!==void 0}};export{s as AsyncQueue};
+//# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["import {newFlatomise} from '@alwatr/flatomise';\n\nimport type {Dictionary} from '@alwatr/type-helper';\n\n/**\n * A queue that executes async tasks in order like mutex and semaphore methodology\n *\n * @example\n * ```ts\n * const queue = new AsyncQueue();\n *\n * function longTask() {\n *   queue.push('longTaskId', async () => {\n *     // ...\n *   });\n * }\n * ```\n */\nexport class AsyncQueue {\n  /**\n   * A record of task IDs and their corresponding last queued task promises.\n   */\n  private queue__: Dictionary<Promise<void>> = {};\n\n  /**\n   * Push a async task to the queue.\n   *\n   * @param taskId task id\n   * @param task async task\n   * @returns A promise that resolves when the task is done.\n   *\n   * @example\n   * ```typescript\n   * const queue = new AsyncQueue();\n   *\n   * function longTask() {\n   *  queue.push('longTaskId', async () => {\n   *   // ...\n   * });\n   * ```\n   */\n  async push(taskId: string, task: () => Promise<void>): Promise<void> {\n    const flatomise = newFlatomise();\n\n    const previousTaskPromise = this.queue__[taskId];\n    this.queue__[taskId] = flatomise.promise;\n\n    try {\n      await previousTaskPromise;\n    }\n    catch (_e) {\n      // ignore\n    }\n\n    setTimeout(() => {\n      task().then(flatomise.resolve, flatomise.reject).then(() => {\n        if (this.queue__[taskId] === flatomise.promise) {\n          delete this.queue__[taskId];\n        }\n      });\n    }, 0);\n\n    return flatomise.promise;\n  }\n\n  /**\n   * Check if the task running in the queue.\n   *\n   * @param taskId task id\n   * @returns true if the task is running, otherwise false.\n   */\n  isRunning(taskId: string): boolean {\n    return this.queue__[taskId] !== undefined;\n  }\n}\n"],
+  "mappings": ";wKAAA,OAAQ,gBAAAA,MAAmB,oBAkBpB,IAAMC,EAAN,KAAiB,CAAjB,cAILC,EAAA,KAAQC,IAAqC,CAAC,GAmB9C,MAAM,KAAKC,EAAgBC,EAA0C,CACnE,IAAMC,EAAYN,EAAa,EAEzBO,EAAsB,KAAKJ,EAAQC,CAAM,EAC/C,KAAKD,EAAQC,CAAM,EAAIE,EAAU,QAEjC,GAAI,CACF,MAAMC,CACR,MACW,CAEX,CAEA,kBAAW,IAAM,CACfF,EAAK,EAAE,KAAKC,EAAU,QAASA,EAAU,MAAM,EAAE,KAAK,IAAM,CACtD,KAAKH,EAAQC,CAAM,IAAME,EAAU,SACrC,OAAO,KAAKH,EAAQC,CAAM,CAE9B,CAAC,CACH,EAAG,CAAC,EAEGE,EAAU,OACnB,CAQA,UAAUF,EAAyB,CACjC,OAAO,KAAKD,EAAQC,CAAM,IAAM,MAClC,CACF",
+  "names": ["newFlatomise", "AsyncQueue", "__publicField", "queue__", "taskId", "task", "flatomise", "previousTaskPromise"]
+}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@alwatr/async-queue",
+  "version": "1.0.0",
+  "description": "A queue that executes async tasks in order like mutex and semaphore methodology for javascript and typescript.",
+  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
+  "keywords": [
+    "async-queue",
+    "async",
+    "queue",
+    "mutex",
+    "semaphore",
+    "lock",
+    "SpinLock",
+    "spin-lock",
+    "SemaphoreSlim",
+    "semaphore-slim",
+    "cross-platform",
+    "ECMAScript",
+    "typescript",
+    "javascript",
+    "node",
+    "nodejs",
+    "esm",
+    "module",
+    "utility",
+    "util",
+    "utils",
+    "nanolib",
+    "alwatr"
+  ],
+  "type": "module",
+  "main": "./dist/main.cjs",
+  "module": "./dist/main.mjs",
+  "types": "./dist/main.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/main.mjs",
+      "require": "./dist/main.cjs",
+      "types": "./dist/main.d.ts"
+    }
+  },
+  "license": "MIT",
+  "files": [
+    "**/*.{js,mjs,cjs,map,d.ts,html,md}",
+    "!demo/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Alwatr/nanolib",
+    "directory": "packages/async-queue"
+  },
+  "homepage": "https://github.com/Alwatr/nanolib/tree/next/packages/async-queue#readme",
+  "bugs": {
+    "url": "https://github.com/Alwatr/nanolib/issues"
+  },
+  "prettier": "@alwatr/prettier-config",
+  "scripts": {
+    "b": "yarn run build",
+    "w": "yarn run watch",
+    "c": "yarn run clean",
+    "cb": "yarn run clean && yarn run build",
+    "d": "yarn run build:es && ALWATR_DEBUG=1 yarn node",
+    "build": "yarn run build:ts & yarn run build:es",
+    "build:es": "nano-build --preset=module",
+    "build:ts": "tsc --build",
+    "watch": "yarn run watch:ts & yarn run watch:es",
+    "watch:es": "yarn run build:es --watch",
+    "watch:ts": "yarn run build:ts --watch --preserveWatchOutput",
+    "clean": "rm -rfv dist *.tsbuildinfo"
+  },
+  "dependencies": {
+    "@alwatr/flatomise": "^1.0.0"
+  },
+  "devDependencies": {
+    "@alwatr/nano-build": "^1.2.3",
+    "@alwatr/prettier-config": "^1.0.4",
+    "@alwatr/tsconfig-base": "^1.1.0",
+    "@alwatr/type-helper": "^1.0.2",
+    "@types/node": "^20.10.6",
+    "typescript": "^5.3.3"
+  },
+  "gitHead": "154de55566d7f39bba46d269585bae838499f0bf"
+}