docs: add getWorkers documentation fixes #1665

OptimalBits · Jul 16, 2021 · 57d8679 · 57d8679
1 parent 3fe17d8
commit 57d8679
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -32,6 +32,7 @@
   - [Queue#getDelayed](#queuegetdelayed)
   - [Queue#getCompleted](#queuegetcompleted)
   - [Queue#getFailed](#queuegetfailed)
+  - [Queue#getWorkers](#queuegetworkers)
 
 - [Job](#job)
 
@@ -682,6 +683,17 @@ Returns a promise that will return an array with the failed jobs between start a
 
 ---
 
+### Queue#getWorkers
+
+```ts
+getWorkers() : Promise<Array<Object>>
+```
+
+Returns a promise that will return an array workers currently listening or processing jobs.
+The object includes the same fields as [Redis CLIENT LIST](https://redis.io/commands/client-list) command.
+
+---
+
 ### Queue#clean
 
 ```ts