# koa-better-response-handler

> Express.js response handler interface for Koa.js (identical).

Latest version **3.1.0** (published 2021-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install koa-better-response-handler
pnpm add koa-better-response-handler
yarn add koa-better-response-handler
bun add koa-better-response-handler
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2021-12-28 |
| First published | 2020-12-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | imed jaberi |
| Maintainers | 3imed-jaberi |
| Keywords | koa, middleware, response-handler, koa-response-handler |

## Links

- npm: https://www.npmjs.com/package/koa-better-response-handler
- Repository: https://github.com/3imed-jaberi/koa-better-response-handler
- Homepage: https://github.com/3imed-jaberi/koa-better-response-handler#readme
- Issues: https://github.com/3imed-jaberi/koa-better-response-handler/issues
- npm.io page: https://npm.io/package/koa-better-response-handler

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 3.1.0 (latest) — 2021-12-28
- 3.0.1 — 2021-12-26
- 3.0.0 — 2021-12-07
- 2.1.0 — 2021-10-03
- 2.0.0 — 2021-02-02
- 1.0.1 — 2020-12-27
- 1.0.0 — 2020-12-26

## README

# koa-better-response-handler

---

[![Build Status][travis-img]][travis-url]
[![Coverage Status][coverage-img]][coverage-url]
[![NPM version][npm-badge]][npm-url]
[![License][license-badge]][license-url]
![Code Size][code-size-badge]

<!-- ***************** -->

[travis-img]: https://travis-ci.org/3imed-jaberi/koa-better-response-handler.svg?branch=master
[travis-url]: https://travis-ci.org/3imed-jaberi/koa-better-response-handler
[coverage-img]: https://coveralls.io/repos/github/3imed-jaberi/koa-better-response-handler/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/3imed-jaberi/koa-better-response-handler?branch=master
[npm-badge]: https://img.shields.io/npm/v/koa-better-response-handler.svg?style=flat
[npm-url]: https://www.npmjs.com/package/koa-better-response-handler
[license-badge]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
[license-url]: https://github.com/3imed-jaberi/koa-better-response-handler/blob/master/LICENSE
[code-size-badge]: https://img.shields.io/github/languages/code-size/3imed-jaberi/koa-better-response-handler
[koa-is-json]: https://github.com/koajs/is-json
[express.js]: https://github.com/expressjs/express
[koa-views]: https://github.com/queckezz/koa-views
[koa-safe-jsonp]: https://github.com/koajs/koa-safe-jsonp

<!-- ***************** -->

Express.js response handler interface for Koa.js (identical).

- 🦄 Inspired from [Express.js].
- 🔥 Amiable and lightweight handler.
- 💅🏻 Express-style handler (`.send()`, `.json()`, `.render()`, `.statusCode()` etc.)
- 🎈 Support for `.render()` methods through [koa-views] middelware.
- 📍 Support for `.jsonp()` methods through [koa-safe-jsonp] middelware.
- ⚖️ Tiny Bundle.

## `Installation`

```bash
# koa-is-json: need when you use `.json()` to check passed data is json.

# npm
$ npm i koa-better-response-handler koa-is-json
# yarn
$ yarn add koa-better-response-handler koa-is-json
```

## `Usage`

This is a practical example of how to use.

```javascript
const Koa = require('koa');
const responseHandler = require('koa-better-response-handler');

const app = new Koa();

app.use(responseHandler());
// ==> ctx.statusCode(200).send('Hello World')
// ==> ctx.statusCode(200).json({ msg: 'Hello World' })
// ==> ctx.statusCode(200).sendStatus() // OK
```

### `OPTIONS`

By default `koa-better-response-handler` use [koa-is-json] to validate
the passed data but you can ignore the installation of `koa-is-json`
and use your custom json checker function by pass and object like this:

```javascript
app.use(
  responseHandler({
    isJSON: (data) => {
      /* custom json checker */
    }
  })
);
```

## `Note`

We don't support `render` and `jsonp` methods purely by this module
we expect that use some others packages like `koa-views` and `koa-safe-jsonp`.

### `.render`

Make sure to use [koa-views] middelware first.

```javascript
const Koa = require('koa');
const views = require('koa-views'); // support render method.
const responseHandler = require('koa-better-response-handler');

const app = new Koa();

app
  .use(views()) // --> ctx.render().
  .use(responseHandler());
```

[More information about `koa-views`](https://github.com/queckezz/koa-views)

### `.jsonp`

Make sure to use [koa-safe-jsonp] middelware first.

```javascript
const Koa = require('koa');
const jsonp = require('koa-safe-jsonp'); // support jsonp method.
const responseHandler = require('koa-better-response-handler');

const app = new Koa();

jsonp(app); // --> ctx.jsonp().

app.use(responseHandler());
```

[More information about `koa-safe-jsonp`](https://github.com/koajs/koa-safe-jsonp)

#### License

---

[MIT](LICENSE) &copy; [Imed Jaberi](https://github.com/3imed-jaberi)

---
_Source: https://npm.io/package/koa-better-response-handler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._