Skip to content

Commit

Permalink
chore(README): Update Queue#checkHealth() description
Browse files Browse the repository at this point in the history
  • Loading branch information
hughsw committed Apr 20, 2020
1 parent d018be3 commit 5470e0e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -558,7 +558,7 @@ Note that for calls that specify an interval, you must provide a callback if you

#### Queue#checkHealth([cb])

Check the "health" of the queue. Returns a promise that resolves to the number of jobs in each state (`waiting`, `active`, `succeeded`, `failed`, `delayed`), and the newest job ID (if using the default ID behavior) in `newestJob`. You can periodically query the `newestJob` ID to estimate the job creation throughput, and can infer the job processing throughput by incorporating the `waiting` and `active` counts.
Check the "health" of the queue. Returns a promise that resolves to the number of jobs in each state (`waiting`, `active`, `succeeded`, `failed`, `delayed`), and the total number of jobs saved (with a default ID) in `newestJob`. You can periodically query `newestJob` to estimate the job creation throughput, and can infer the job processing throughput by incorporating the `waiting` and `active` counts.

```js
const counts = await queue.checkHealth();
Expand Down

0 comments on commit 5470e0e

Please sign in to comment.