Expressive middleware for node.js using ES2017 async functions, now with less dependancies
 
 
Go to file
TJ Holowaychuk 2359b6a769 Merge pull request #483 from squarejaw/test-coverage
Increase test coverage
2015-10-02 18:44:49 -07:00
benchmarks add experimental to benchmark 2015-04-23 18:36:02 +08:00
docs add app.context docs 2015-08-30 22:20:53 -05:00
lib implement ctx.origin 2015-09-20 23:49:37 +08:00
test Increase test coverage 2015-10-02 19:18:05 -05:00
.gitignore 0.14.0 2014-12-15 10:13:40 -08:00
.travis.yml add node 4.x on travis ci 2015-09-10 01:36:38 +08:00
AUTHORS update authors 2015-08-20 01:05:43 +08:00
History.md 1.0.0 2015-08-22 14:47:31 -07:00
LICENSE update license and add AUTHORS file. Closes #386 2014-12-31 11:06:54 -08:00
Makefile get rid of 0.11 2015-08-30 23:42:44 +08:00
Readme.md improve verbage based on comments 2015-08-30 22:07:54 -07:00
package.json get rid of 0.11 2015-08-30 23:42:44 +08:00

Readme.md

koa middleware framework for nodejs

gitter NPM version build status Test coverage

Expressive HTTP middleware for node.js to make web applications and APIs more enjoyable to write. Koa's middleware stack flows 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.

Koa is not bundled with any middleware.

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.12.0 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