Expressive middleware for node.js using ES2017 async functions, now with less dependancies
Find a file
2015-08-20 01:05:43 +08:00
benchmarks add experimental to benchmark 2015-04-23 18:36:02 +08:00
docs Clarify precondition for freshness check 2015-07-16 00:37:41 -07:00
lib return same object from request.query 2015-05-21 12:55:58 -07:00
test fix a possible typo 2015-07-03 18:55:24 +08:00
.gitignore 0.14.0 2014-12-15 10:13:40 -08:00
.travis.yml build: support iojs 3.x 2015-08-20 01:01:27 +08:00
AUTHORS update authors 2015-08-20 01:05:43 +08:00
History.md 0.21.0 2015-05-23 20:15:23 -07:00
LICENSE update license and add AUTHORS file. Closes 2014-12-31 11:06:54 -08:00
Makefile deps: upgrade should, install should-http 2015-05-24 11:08:20 +02:00
package.json deps: upgrade should, install should-http 2015-05-24 11:08:20 +02:00
Readme.md fix Chinese doc link 2015-04-05 20:24:06 +08:00

koa middleware framework for nodejs

gitter NPM version build status Test coverage

Expressive middleware for node.js using generators via co to make web applications and APIs more enjoyable to write. Koa's middleware flow in a stack-like manner allowing you to perform actions downstream, then filter and manipulate the response upstream. Koa's use of generators also greatly increases the readability and robustness of your application.

Only methods that are common to nearly all HTTP servers are integrated directly into Koa's small ~550 SLOC codebase. This includes things like content-negotiation, normalization of node inconsistencies, redirection, and a few others.

No middleware are bundled with koa.

Installation

$ npm install koa

Koa is supported in all versions of iojs without any flags.

To use Koa with node, you must be running node 0.11.16 or higher for generator and promise support, and must run node(1) with the --harmony-generators or --harmony flag.

Community

Getting started

  • Kick-Off-Koa - An intro to koa via a set of self-guided workshops.
  • Workshop - A workshop to learn the basics of koa, Express' spiritual successor.
  • Introduction Screencast - An introduction to installing and getting started with Koa

Example

var koa = require('koa');
var app = koa();

// logger

app.use(function *(next){
  var start = new Date;
  yield next;
  var ms = new Date - start;
  console.log('%s %s - %s', this.method, this.url, ms);
});

// response

app.use(function *(){
  this.body = 'Hello World';
});

app.listen(3000);

Running tests

$ make test

Authors

License

MIT