chore: add typedoc comment for waitForShift

libkakashi · Jul 20, 2024 · d3fe4c9 · d3fe4c9
1 parent 30afdca
commit d3fe4c9
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -61,6 +61,9 @@ class Queue<T> {
     this.piped = true;
   }
 
+  /*
+   * Returns a promise that resolves when any item has been consumed from the queue.
+   */
   waitForShift = () =>
     new Promise<void>(resolve => this._shiftResolvers.push(resolve));