Skip to content

Commit

Permalink
docs: update documentation of waitUntillFinishes to match behavior
Browse files Browse the repository at this point in the history
updates the documentation of the method to match the actual behavior, which returns a rejected promise when job failes. 

closes taskforcesh#1031
  • Loading branch information
bilalshaikh42 committed Jan 28, 2022
1 parent e55ff35 commit 0dec3d0
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/classes/job.ts
Original file line number Diff line number Diff line change
Expand Up @@ -733,7 +733,8 @@ export class Job<
}

/**
* Returns a promise the resolves when the job has finished. (completed or failed).
* Returns a promise the resolves when the job has completed (containing the return value of the job),
* or rejects when the job has failed (containing the failedReason).
*
* @param queueEvents - Instance of QueueEvents.
* @param ttl - Time in milliseconds to wait for job to finish before timing out.
Expand Down

0 comments on commit 0dec3d0

Please sign in to comment.