koa-lite/docs/error-handling.md

62 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2016-02-29 20:22:59 +00:00
# Error Handling
## Try-Catch
2016-03-22 18:03:10 +00:00
Using async functions means that you can try-catch `next`.
This example adds a `.status` to all errors:
2016-02-29 20:22:59 +00:00
```js
app.use(async (ctx, next) => {
2016-02-29 20:22:59 +00:00
try {
await next();
2016-03-22 18:03:10 +00:00
} catch (err) {
err.status = err.statusCode || err.status || 500;
throw err;
2016-02-29 20:22:59 +00:00
}
});
```
### Default Error Handler
The default error handler is essentially a try-catch at
the very beginning of the middleware chain. To use a
different error handler, simply put another try-catch at
the beginning of the middleware chain, and handle the error
there. However, the default error handler is good enough for
most use cases. It will use a status code of `err.status`,
or by default 500. If `err.expose` is true, then `err.message`
will be the reply. Otherwise, a message generated from the
error code will be used (e.g. for the code 500 the message
"Internal Server Error" will be used). All headers will be
cleared from the request, but any headers in `err.headers`
will then be set. You can use a try-catch, as specified
above, to add a header to this list.
2016-03-22 18:03:10 +00:00
Here is an example of creating your own error handler:
```js
app.use(async (ctx, next) => {
try {
await next();
} catch (err) {
// will only respond with JSON
ctx.status = err.statusCode || err.status || 500;
ctx.body = {
2016-03-22 18:03:10 +00:00
message: err.message
};
}
})
```
2016-02-29 20:22:59 +00:00
## The Error Event
2016-03-22 18:03:10 +00:00
Error event listeners can be specified with `app.on('error')`.
If no error listener is specified, a default error listener
is used. Error listener receive all errors that make their
2016-02-29 20:22:59 +00:00
way back through the middleware chain, if an error is caught
2016-03-22 18:03:10 +00:00
and not thrown again, it will not be passed to the error
listener. If no error event listener is specified, then
`app.onerror` will be used, which simply log the error unless
`error.expose`is true or `app.silent` is true or `error.status`
is 404.