https://github.com/yoctol/koa-final-handler

Final handler middleware for koa.
https://github.com/yoctol/koa-final-handler

Last synced: 30 days ago
JSON representation

Final handler middleware for koa.

• Host: GitHub
• URL: https://github.com/yoctol/koa-final-handler
• Owner: Yoctol
• Created: 2018-05-05T16:03:55.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T04:07:05.000Z (over 3 years ago)
• Last Synced: 2025-06-24T04:09:07.982Z (12 months ago)
• Language: JavaScript
• Size: 466 KB
• Stars: 1
• Watchers: 10
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# koa-final-handler

[![Build Status](https://travis-ci.org/Yoctol/koa-final-handler.svg?branch=master)](https://travis-ci.org/Yoctol/koa-final-handler)

[![npm](https://img.shields.io/npm/v/@yoctol/koa-final-handler.svg)](https://www.npmjs.com/package/@yoctol/koa-final-handler)

> Final handler middleware for [koa](https://github.com/koajs/koa)

## Installation

Install using npm:

```sh

npm install @yoctol/koa-final-handler

```

## Usage

```js

const Koa = require('koa');

const finalHandler = require('@yoctol/koa-final-handler');

const app = new Koa();

app.use(finalHandler());

/* using other middleware after this line */

app.use(auth());

app.use(route());

app.listen(8080, () => {

  console.log('server is running on http://localhost:8080');

});

```

### Response Body

The middleware will append error object on response body when `NODE_ENV` is `development`.

```js

const { error } = response.body;

```

### Error Reporting

```js

const handleErrorReporting = (error, ctx) => {

  /* your error reporting handler */

};

app.on('error', handleErrorReporting);

```