From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Thu, 18 Jul 2024 19:03:49 +0000 (+0200)
Subject: docs: add documentation on enablePrority priority queue getter/setter
X-Git-Tag: v4.2.0~61
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=3e53cc14e502b532f31536efefe84212c98ee024;p=poolifier.git

docs: add documentation on enablePrority priority queue getter/setter

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
---

diff --git a/src/queues/priority-queue.ts b/src/queues/priority-queue.ts
index 797aadf9..6b1fd308 100644
--- a/src/queues/priority-queue.ts
+++ b/src/queues/priority-queue.ts
@@ -59,10 +59,18 @@ export class PriorityQueue<T> {
     return size
   }
 
+  /**
+   * Whether priority is enabled.
+   * @returns Whether priority is enabled.
+   */
   public get enablePriority (): boolean {
     return this.priorityEnabled
   }
 
+  /**
+   * Enables/disables priority.
+   * @param enablePriority - Whether to enable priority.
+   */
   public set enablePriority (enablePriority: boolean) {
     if (this.priorityEnabled === enablePriority) {
       return