# koa2-connect

> Use Connect/Express middleware in Koa2

Latest version **1.0.2** (published 2017-01-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install koa2-connect
pnpm add koa2-connect
yarn add koa2-connect
bun add koa2-connect
```

## 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 | 1.0.2 |
| Published | 2017-01-12 |
| First published | 2017-01-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 26 |
| Author | cyrilluce |
| Maintainers | cyrilluce, vkurchatkin |
| Keywords | koa, koa2, connect, express, middleware |

## Links

- npm: https://www.npmjs.com/package/koa2-connect
- Repository: https://github.com/cyrilluce/koa2-connect
- Homepage: https://github.com/cyrilluce/koa2-connect#readme
- Issues: https://github.com/cyrilluce/koa2-connect/issues
- npm.io page: https://npm.io/package/koa2-connect

## 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

- 1.0.2 (latest) — 2017-01-12
- 1.0.1 — 2017-01-11
- 1.0.0 — 2017-01-11

## README

# koa2-connect
Base on [koa-connect](https://github.com/vkurchatkin/koa-connect), improve to support webpack-dev-middleware and webpack-hot-middleware.
Use [Express](https://github.com/strongloop/express)/[Connect](https://github.com/senchalabs/connect) middleware with Koa.

## Warning
It is **highly** recommended to use a Koa-specific middleware instead of trying to convert an Express version when they're available. There is a non-trivial difference in the Koa and Express designs and you will inevitably run into some issues. This module is a workaround for the specific cases where the differences can be ignored. Additionally, it also enables library authors to write 1 version of their HTTP middleware.

### Always use `next`
Express middlewares need to declare and invoke the `next` callback appropriately for the koa-connect integration to work correctly.

### For library authors
If you're attempting to write a framework-agnostic middleware library, be sure to use only core HTTP methods and not any Express-dependent APIs like `res.send`.

## Installation

```sh
npm install koa2-connect
```

## Usage
See `examples/` for more real-world examples.

```javascript
const Koa = require('koa')
const c2k = require('koa2-connect')

// A generic Express-style middleware function
function connectMiddlware (req, res, next) {
  res.writeHead(200, {'Content-Type': 'text/plain'})
  res.end('From the Connect middleware')
  next()
}

// A generic Koa v2 middlware, without async/await
function koaMiddlware(ctx, next) {
  return next()
    .then(() => {
      // The control flow will bubble back to here, like usual
    })
    .catch((err) => {
      // Error handling from downstream middleware, like usual
    })
}

// A generic Koa v2 middlware with async/await
async function koaMiddleware(ctx, next) {
  try {
    await next();
  } catch (e) {
    // Normal error handling
  }
  // Normal control flow
}

const app = new Koa()
app.use(koaMiddlware)
app.use(c2k(connectMiddlware))
app.use((ctx, next) => {
  console.log('It will continue on to here')
})

app.listen(3000)
```

## Testing
Tests are in `tests.js` and are made with the [Mocha](https://mochajs.org) framework. You can run them with `npm test` or `npm run test:watch`

## License
MIT

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