Expressive middleware for node.js using ES2017 async functions, now with less dependancies
Find a file
TJ Holowaychuk bbbbfcc37a docs
2013-08-17 00:33:28 -07:00
benchmarks Initial commit 2013-08-17 00:15:57 -07:00
docs Initial commit 2013-08-17 00:15:57 -07:00
examples Initial commit 2013-08-17 00:15:57 -07:00
lib Initial commit 2013-08-17 00:15:57 -07:00
test Initial commit 2013-08-17 00:15:57 -07:00
.gitignore Initial commit 2013-08-17 00:15:57 -07:00
.npmignore Initial commit 2013-08-17 00:15:57 -07:00
index.js Initial commit 2013-08-17 00:15:57 -07:00
LICENSE Initial commit 2013-08-17 00:15:57 -07:00
Makefile Initial commit 2013-08-17 00:15:57 -07:00
package.json Initial commit 2013-08-17 00:15:57 -07:00
Readme.md docs 2013-08-17 00:33:28 -07:00

koa middleware framework for nodejs

Expressive middleware for node.js using generators via co to make writing web applications and REST APIs more enjoyable to write.

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

No middleware are bundled with koa. If you prefer to only define a single dependency for common middleware, much like Connect, you may use koa-common.

Installation

$ npm install koa

To use Koa you must be running node 0.11.4 or higher for generator support, and must run node(1) with the --harmony-generators flag. If you don't like typing this, add an alias to your shell profile:

alias node='node --harmony-generators'

Community

Example

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

// logger

app.use(function(next){
  return function *(){
    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(next){
  return function *(){
    yield next;
    this.body = 'Hello World';
  }
});

app.listen(3000);

Running tests

$ make test

License

MIT