1.0.2 • Published 8 years ago

koa2-connect v1.0.2

Weekly downloads
2,617
License
MIT
Repository
github
Last release
8 years ago

koa2-connect

Base on koa-connect, improve to support webpack-dev-middleware and webpack-hot-middleware. Use Express/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

npm install koa2-connect

Usage

See examples/ for more real-world examples.

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 framework. You can run them with npm test or npm run test:watch

License

MIT

@amare/elvesmxs-mockmaxs-mock@electron.land/electron-scripts@ez-fe/ez@infinitebrahmanuniverse/nolb-koa2@everything-registry/sub-chunk-2025talentui-dev-servervrayvite-plugin-proxyve-job-action@discuzq.icu/cli@discuzq/cli@discuzqfe/cli@discuzqsdk/cli@bluefunctor/local-dnskoa-http-proxy-serverkoa-server-http-proxyksc-mockerssr-common-utilsssr-server-utilstm-mock-servertiger-server-utilstmmodulestn-ssr-server-utils@banshan-alec/egg-vite-middleware@aaj/apiyakuza0yakuza3ys0-serverzen-mockserverwebpack-toolwebickwebick-su@hankliu/webpack-dev-server@hset/xlang-runtime-middleware@hengshuai/ssr-common-utils@gem-mine/cli-service@gem-mine/script@ljkburn/mycli@ljkburn/webick@node-kits/koa@node-kits/aliyun@node-kits/aliyun-starter@egglib/http-proxy@egglib/statics-webpack@jv2/egg-jv-common@jv2/egg-jv-common-server@jsk-server/koa@imoka/imoka-cli@tilemoon/tiga@smadey/egg-vite-plugin@seasonjs/tegg-vite-pluginmock-koa-servicemofish-plugin-proxymock-server-local-ccmock-server-localmext-servermidway-vite-viewmm_koa_proxymm_proxyohpack-webpack-toolnick-scriptplaso-proxy-middlewarepurser-server-utilsrazzle-hacknewsreact-proxy-serverhttp-proxy-middleware-for-koa2little-node-mvclocal-proxy-serverkoa2-static-serverkoa2-nginxkoa2-proxy-middlewarekoa2-proxy-plusmaxt-server@web-tsp/proxy@zctya/vite-egg-plugin@ze-us/proxyavatar-mock-serveraward-serverathene-apiaext-server@tkrjs/core@tntd/proxy-server@umajs/plugin-proxybyted-react-scriptscango-clidiscuzq-cli-fixeddfws-cryptodfws-jq-uploaddomain-proxyduke-node-serverecui-cliecui-n-cliegg-http-proxyegg-vue-ssr-dev-serveregg-gateway-proxyegg-proxy-pluginegg-proxy-viewegg-vite
1.0.2

8 years ago

1.0.1

8 years ago

1.0.0

8 years ago