From 3e53cc14e502b532f31536efefe84212c98ee024 Mon Sep 17 00:00:00 2001
From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= <jerome.benoit@piment-noir.org>
Date: Thu, 18 Jul 2024 21:03:49 +0200
Subject: [PATCH] docs: add documentation on enablePrority priority queue
 getter/setter
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
---
 src/queues/priority-queue.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

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
-- 
2.34.1