docs(async-queue): jsdoc

Alwatr · Jan 3, 2024 · 2bbfe04 · 2bbfe04
1 parent 2e54a0a
commit 2bbfe04
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/packages/async-queue/demo/simple-queue.mjs b/packages/async-queue/demo/simple-queue.mjs
@@ -5,10 +5,10 @@ const queue = new AsyncQueue();
 async function longTask(n) {
   console.log('longTask(%s)', n);
   await queue.push('longTaskId', () => {
-    return new Promise(resolve => {
+    return new Promise((resolve) => {
       console.log('longTask %s start', n);
       // Simulate a long task
-      setTimeout(resolve, 1_000)
+      setTimeout(resolve, 1_000);
     });
   });
   console.log('longTask %s end', n);
@@ -18,4 +18,4 @@ async function longTask(n) {
 longTask(1);
 longTask(2);
 longTask(3).then(() => console.log('longTask 3 resolved'));
-longTask(4)
+longTask(4);
diff --git a/packages/async-queue/src/main.ts b/packages/async-queue/src/main.ts
@@ -17,6 +17,9 @@ import type {Dictionary} from '@alwatr/type-helper';
  * ```
  */
 export class AsyncQueue {
+  /**
+   * A record of task IDs and their corresponding last queued task promises.
+   */
   private queue__: Dictionary<Promise<void>> = {};
 
   /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,6 +17,9 @@ import type {Dictionary} from '@alwatr/type-helper'; @@
      * ```
      */
     export class AsyncQueue {
+      /**
+       * A record of task IDs and their corresponding last queued task promises.
+       */
       private queue__: Dictionary<Promise<void>> = {};
       /**
@@ Expand Down @@