refactor: silence jsdoc linting warnings

[poolifier.git] / src / priority-queue.ts

diff --git a/src/priority-queue.ts b/src/priority-queue.ts
index ee3310c3d8f2cb8cf6e4d6287d0a668eb20f4a9c..18478afefbcb0e90c12f300d07305568f8e4a661 100644 (file)
--- a/src/priority-queue.ts
+++ b/src/priority-queue.ts
@@ -9,7 +9,6 @@ export const defaultBucketSize = 2048
 
 /**
  * Priority queue node.
- *
  * @typeParam T - Type of priority queue node data.
  * @internal
  */
@@ -19,7 +18,6 @@ export interface PriorityQueueNode<T> extends FixedPriorityQueue<T> {
 
 /**
  * Priority queue.
- *
  * @typeParam T - Type of priority queue data.
  * @internal
  */
@@ -32,7 +30,6 @@ export class PriorityQueue<T> {
 
   /**
    * Constructs a priority queue.
-   *
    * @param bucketSize - Prioritized bucket size. @defaultValue defaultBucketSize
    * @param enablePriority - Whether to enable priority. @defaultValue false
    * @returns PriorityQueue.
@@ -43,11 +40,11 @@ export class PriorityQueue<T> {
   ) {
     if (!Number.isSafeInteger(bucketSize)) {
       throw new TypeError(
-        `Invalid bucket size: '${bucketSize}' is not an integer`
+        `Invalid bucket size: '${bucketSize.toString()}' is not an integer`
       )
     }
     if (bucketSize < 0) {
-      throw new RangeError(`Invalid bucket size: ${bucketSize} < 0`)
+      throw new RangeError(`Invalid bucket size: ${bucketSize.toString()} < 0`)
     }
     this.bucketSize = bucketSize
     this.head = this.tail = new FixedPriorityQueue(
@@ -59,6 +56,7 @@ export class PriorityQueue<T> {
 
   /**
    * The priority queue size.
+   * @returns The priority queue size.
    */
   public get size (): number {
     let node: PriorityQueueNode<T> | undefined = this.tail
@@ -87,6 +85,7 @@ export class PriorityQueue<T> {
 
   /**
    * The number of filled prioritized buckets.
+   * @returns The number of filled prioritized buckets.
    */
   public get buckets (): number {
     return Math.trunc(this.size / this.bucketSize)
@@ -94,7 +93,6 @@ export class PriorityQueue<T> {
 
   /**
    * Enqueue data into the priority queue.
-   *
    * @param data - Data to enqueue.
    * @param priority - Priority of the data. Lower values have higher priority.
    * @returns The new size of the priority queue.
@@ -116,7 +114,6 @@ export class PriorityQueue<T> {
 
   /**
    * Dequeue data from the priority queue.
-   *
    * @param bucket - The prioritized bucket to dequeue from.
    * @returns The dequeued data or `undefined` if the priority queue is empty.
    */
@@ -171,7 +168,6 @@ export class PriorityQueue<T> {
 
   /**
    * Returns an iterator for the priority queue.
-   *
    * @returns An iterator for the priority queue.
    * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
    */
@@ -184,7 +180,7 @@ export class PriorityQueue<T> {
         if (value == null) {
           return {
             value: undefined,
-            done: true
+            done: true,
           }
         }
         ++index
@@ -194,9 +190,9 @@ export class PriorityQueue<T> {
         }
         return {
           value,
-          done: false
+          done: false,
         }
-      }
+      },
     }
   }
 }