oban-bg/oban

Documentation request: What happens if a job times out?

Closed this issue · 1 comments

The documentation on timeouts does a great job of explaining how to add a timeout to a job, but does not explain what happens if a timeout occurs. Does it return {:error, :timeout}? Does it simply fail?

Would love to see the consequences of adding a timeout so we can plan accordingly in our error handlers 🙇

Does it return {:error, :timeout}? Does it simply fail?

The short answer is that it errors with an Oban.TimeoutError. We'll update the docs with that info.