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.

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

Improve Documentation on Error Handling #1046

Open
pdfowler opened this issue Apr 1, 2020 · 0 comments
Open

Improve Documentation on Error Handling #1046

pdfowler opened this issue Apr 1, 2020 · 0 comments

Comments

@pdfowler
Copy link

@pdfowler pdfowler commented Apr 1, 2020

On my team, we've been implementing error handling in agenda jobs in one of two ways:

  1. Catch the error, call job.fail(err); job.save(), return
  2. Throw the error

After looking at the job processing code for the run method, I confirmed the two approaches were equivalent.


While I love digging thru the source code, a quick blurb on error handling in the docs would be super helpful.

TODO

  • Draft a documentation section on error handling
  • File a PR
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.