1.0.0 • Published 5 years ago

koa-express-adapter v1.0.0

Weekly downloads
169
License
MIT
Repository
github
Last release
5 years ago

The adapter for the migration from express to koa

If you have search the two framework on npm, you will get 16k+ (express) and 4k+ (koa). express has a bigger ecosystem than koa, This package will let you use express middleware in koa application.

Badges

NPM version build status Test coverage npm download

Usage

You can simply wrap express middleware with wrap function.

const { wrap } = require('koa-express-adapter');
const Koa = require('koa');
const app = new Koa();
// wrap express middleware
app.use(wrap(function(req, res) {
  res.send('Hello World');
}));

Note: Don't define next argument when you don't use it.

// it's wrong
app.use(wrap(function(req, res, next) {
  res.send('Hello World');
}));

Express API

Request

  • accepts
  • acceptsCharset
  • acceptsCharsets
  • acceptsEncoding
  • acceptsEncodings
  • acceptsLanguage
  • acceptsLanguages
  • baseUrl
  • fresh
  • get
  • hostname
  • host
  • ip
  • ips
  • is
  • param
  • path
  • protocol
  • query
  • range
  • route
  • secure
  • signedCookies
  • stale
  • subdomains
  • xhr

Response

  • append
  • attachment
  • clearCookie
  • cookie
  • download
  • format
  • get
  • json
  • jsonp
  • links
  • locals
  • location
  • redirect
  • render
  • send
  • sendFile
  • sendStatus
  • set
  • status
  • type
  • vary

Testcase

Thanks for express testcase for compatible unittest.

License

(The MIT License)