Skip to content

Commit 83dca16

Browse files
authored
Merge pull request #80 from TimDaub/patch-1
Add time unit of "average" stats to docs
2 parents a74fffe + 306cd09 commit 83dca16

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -536,14 +536,14 @@ apply to the tasks that have not yet finished/failed.
536536
#### Queue Statistics
537537

538538
You can inspect the queue at any given time to see information about how many items are
539-
queued, average queue time, success rate and total item processed.
539+
queued, average queue time in milliseconds, success rate and total item processed.
540540

541541
```js
542542
var q = new Queue(fn);
543543
var stats = q.getStats();
544544

545545
// stats.total = Total tasks processed
546-
// stats.average = Average process time
546+
// stats.average = Average process time in milliseconds
547547
// stats.successRate = % success (between 0 and 1)
548548
// stats.peak = Most tasks queued at any given point in time
549549
```
@@ -727,7 +727,7 @@ A process function is required, all other options are optional.
727727
- `resume()` - Resumes the queue and its runnign tasks.
728728
- `destroy(cb)` - Destroys the queue: closes the store, tries to clean up.
729729
- `use(store)` - Sets the queue to read from and write to the given store.
730-
- `getStats()` - Gets the aggregate stats for the queue. Returns an object with properties `successRate`, `peak`, `total` and `average`, representing the success rate on tasks, peak number of items queued, total number of items processed and average processing time, respectively.
730+
- `getStats()` - Gets the aggregate stats for the queue. Returns an object with properties `successRate`, `peak`, `total` and `average`, representing the success rate on tasks, peak number of items queued, total number of items processed and average processing time in milliseconds, respectively.
731731
- `resetStats()` - Resets all of the aggregate stats.
732732

733733
#### Events on Queue

0 commit comments

Comments
 (0)