Skip to content

readme: fix documentation of event details #105

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

readme: fix documentation of event details #105

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,13 +180,13 @@ Immediately before a job begins to execute.
### `q.dispatchEvent(new QueueEvent('success', { result: [...result], job }))`
After a job executes its callback.

### `q.dispatchEvent(new QueueEvent('error', { err, job }))`
### `q.dispatchEvent(new QueueEvent('error', { error, job }))`
After a job passes an error to its callback.

### `q.dispatchEvent(new QueueEvent('timeout', { next, job }))`
After `q.timeout` milliseconds have elapsed and a job has not executed its callback.

### `q.dispatchEvent(new QueueEvent('end', { err }))`
### `q.dispatchEvent(new QueueEvent('end', { error }))`
After all jobs have been processed

## Releases
Expand Down