docs: improve code documentation

[poolifier.git] / src / queue.ts

diff --git a/src/queue.ts b/src/queue.ts
index 7682f65f952136743c1f81724a26e53264ac18ed..ead4b6375388398483eda10abaaae50e2c779928 100644 (file)
--- a/src/queue.ts
+++ b/src/queue.ts
@@ -6,24 +6,15 @@
  * @typeParam T - Type of queue items.
  */
 export class Queue<T> {
-  private items: Record<number, T>
-  private head: number
-  private tail: number
+  private items!: T[]
+  private offset!: number
+  /** The size of the queue. */
+  public size!: number
+  /** The maximum size of the queue. */
+  public maxSize!: number
 
   public constructor () {
-    this.items = {}
-    this.head = 0
-    this.tail = 0
-  }
-
-  /**
-   * Get the size of the queue.
-   *
-   * @returns The size of the queue.
-   * @readonly
-   */
-  public get size (): number {
-    return this.tail - this.head
+    this.clear()
   }
 
   /**
@@ -33,8 +24,11 @@ export class Queue<T> {
    * @returns The new size of the queue.
    */
   public enqueue (item: T): number {
-    this.items[this.tail] = item
-    this.tail++
+    this.items.push(item)
+    ++this.size
+    if (this.size > this.maxSize) {
+      this.maxSize = this.size
+    }
     return this.size
   }
 
@@ -44,23 +38,37 @@ export class Queue<T> {
    * @returns The dequeued item or `undefined` if the queue is empty.
    */
   public dequeue (): T | undefined {
-    if (this.size <= 0) return undefined
-    const item = this.items[this.head]
-    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-    delete this.items[this.head]
-    this.head++
-    if (this.head === this.tail) {
-      this.head = 0
-      this.tail = 0
+    if (this.size <= 0) {
+      return undefined
+    }
+    const item = this.items[this.offset]
+    if (++this.offset * 2 >= this.items.length) {
+      this.items = this.items.slice(this.offset)
+      this.offset = 0
     }
+    --this.size
     return item
   }
 
   /**
-   * Peek at the first item.
+   * Peeks at the first item.
+   *
+   * @returns The first item or `undefined` if the queue is empty.
    */
   public peek (): T | undefined {
-    if (this.size <= 0) return undefined
-    return this.items[this.head]
+    if (this.size <= 0) {
+      return undefined
+    }
+    return this.items[this.offset]
+  }
+
+  /**
+   * Clears the queue.
+   */
+  public clear (): void {
+    this.items = []
+    this.offset = 0
+    this.size = 0
+    this.maxSize = 0
   }
 }