Skip to content
This repository was archived by the owner on Feb 7, 2023. It is now read-only.

Commit

Permalink
Merge pull request OptimalBits#355 from PyroSA/patch-1
Browse files Browse the repository at this point in the history
Update README.md - Queue##clean parameters
  • Loading branch information
manast authored Oct 11, 2016
2 parents 26446b1 + 076197d commit 8ebc4a5
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -581,11 +581,9 @@ __Arguments__
---------------------------------------

<a name="clean"/>
#### Queue##clean(options)
#### Queue##clean(grace, [type], [limit])

Tells the queue remove all jobs created outside of a grace period.
You can clean the jobs with the following states: completed, wait, active,
delayed, and failed.
Tells the queue remove jobs of a specific type created outside of a grace period.

__Example__

Expand All @@ -605,6 +603,7 @@ __Arguments__
grace {int} Grace period in milliseconds.
type {string} type of job to clean. Values are completed, waiting, active,
delayed, and failed. Defaults to completed.
limit {int} maximum amount of jobs to clean per call. If not provided will clean all matching jobs.
returns {Promise} A promise that resolves with an array of removed jobs.
```

Expand Down

0 comments on commit 8ebc4a5

Please sign in to comment.