Expose paused status flag (#91)

* Expose paused status flag * Fix legacy tests
mcollina · Jan 30, 2025 · 45c6b3c · 45c6b3c
1 parent 571b25b
commit 45c6b3c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -233,6 +233,12 @@ each time a task is completed, `err` will be not null if the task has thrown an
 Property that returns the number of concurrent tasks that could be executed in
 parallel. It can be altered at runtime.
 
+-------------------------------------------------------
+<a name="paused"></a>
+### queue.paused
+
+Property (Read-Only) that returns `true` when the queue is in a paused state.
+
 -------------------------------------------------------
 <a name="drain"></a>
 ### queue.drain

diff --git a/index.d.ts b/index.d.ts
@@ -20,6 +20,7 @@ declare namespace fastq {
     killAndDrain(): any
     error(handler: errorHandler<T>): void
     concurrency: number
+    readonly paused: boolean
     drain(): any
     empty: () => void
     saturated: () => void

diff --git a/test/test.js b/test/test.js
@@ -640,3 +640,14 @@ test('pause/resume should trigger drain event', function (t) {
 
   queue.resume()
 })
+
+test('paused flag', function (t) {
+  t.plan(2)
+
+  var queue = buildQueue(function (arg, cb) {
+    cb(null)
+  }, 1)
+  t.equal(queue.paused, false)
+  queue.pause()
+  t.equal(queue.paused, true)
+})