Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(DOCS) Update REFERENCE.md to note a performance footgun #2357

Closed
wants to merge 1 commit into from
Closed

(DOCS) Update REFERENCE.md to note a performance footgun #2357

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -833,7 +833,7 @@ Returns a promise that resolves to a Metrics object.
clean(grace: number, status?: string, limit?: number): Promise<number[]>
```

Tells the queue remove jobs of a specific type created outside of a grace period.
Tells the queue remove jobs of a specific type created outside of a grace period. **Note:** this operation is expensive and _should not_ be utilized on large queues (e.g., queues with over 100,000 tasks).

#### Example

Expand Down