From 6a3b6dc2b40a6e4cb654e76c5d05723f0bfd1755 Mon Sep 17 00:00:00 2001 From: Jannis R Date: Tue, 5 Sep 2023 13:11:15 +0200 Subject: [PATCH] readme: fix documentation of event details The object passed as the 2nd argument to `QueueEvent` ends up being the instance's `.detail`, so it is relevant to correctly state the name of the object's field here. --- readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 83973b2..65e1595 100644 --- a/readme.md +++ b/readme.md @@ -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