https://github.com/koajs/onerror
an error handler for koa, hack ctx.onerror
https://github.com/koajs/onerror
Last synced: 7 days ago
JSON representation
an error handler for koa, hack ctx.onerror
- Host: GitHub
- URL: https://github.com/koajs/onerror
- Owner: koajs
- License: mit
- Created: 2014-04-17T11:23:47.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-02-09T05:26:04.000Z (about 3 years ago)
- Last Synced: 2024-10-29T15:32:17.576Z (6 months ago)
- Language: JavaScript
- Size: 73.2 KB
- Stars: 140
- Watchers: 10
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - onerror
- awesome-koa - onerror - an error handler for koa, hack ctx.onerror (Middleware)
- awesome-koa - koa-onerror - Koa 的错误处理程序，hack ctx.onerror。   (仓库 / 中间件)
README
# koa-onerror
[![NPM version][npm-image]][npm-url]
[![Test coverage][codecov-image]][codecov-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[](https://nodejs.org/en/download/)
[](https://makeapullrequest.com)
[npm-image]: https://img.shields.io/npm/v/koa-onerror.svg?style=flat
[npm-url]: https://npmjs.org/package/koa-onerror
[codecov-image]: https://codecov.io/gh/koajs/onerror/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/koajs/onerror
[snyk-image]: https://snyk.io/test/npm/koa-onerror/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/koa-onerror
[download-image]: https://img.shields.io/npm/dm/koa-onerror.svg?style=flat-square
[download-url]: https://npmjs.org/package/koa-onerror
an error handler for koa, hack ctx.onerror.
different with [koa-error](https://github.com/koajs/error):
- we can not just use try catch to handle all errors, steams' and events'
errors are directly handle by `ctx.onerror`, so if we want to handle all
errors in one place, the only way i can see is to hack `ctx.onerror`.
- it is more customizable.
## install
```bash
npm install koa-onerror
```
## Usage
```js
const fs = require('fs');
const Koa = require('koa');
const { onerror } = require('koa-onerror');
const app = new Koa();
onerror(app);
app.use(ctx => {
// foo();
ctx.body = fs.createReadStream('not exist');
});
```
## Options
```js
onerror(app, options);
```
- **all**: if `options.all` exist, ignore negotiation
- **text**: text error handler
- **json**: json error handler
- **html**: html error handler
- **redirect**: if accept `html` or `text`, can redirect to another error page
check out default handler to write your own handler.
## Status and Headers
`koa-onerror` will automatic set `err.status` as response status code, and `err.headers` as response headers.
## License
[MIT](LICENSE)
## Contributors
[](https://github.com/koajs/onerror/graphs/contributors)
Made with [contributors-img](https://contrib.rocks).