Expressive middleware for node.js using ES2017 async functions, now with less dependancies
 
 
Go to file
Michaël Zasso 0a2d0dad75 add editorconfig 2015-10-13 09:23:57 +02:00
benchmarks refactor Application into a class 2015-10-13 01:19:42 -05:00
docs refactor Application into a class 2015-10-13 01:19:42 -05:00
lib lib: fix style issues 2015-10-13 09:23:57 +02:00
test test: fix style issues 2015-10-13 09:23:57 +02:00
.editorconfig add editorconfig 2015-10-13 09:23:57 +02:00
.eslintrc add eslint and standard config 2015-10-13 09:23:06 +02:00
.gitignore 0.14.0 2014-12-15 10:13:40 -08:00
.travis.yml remove support for node < 4 2015-10-11 21:22:33 -07:00
AUTHORS update AUTHORS 2015-10-12 00:04:06 -07:00
History.md 1.1.0 2015-10-11 16:31:05 -07:00
LICENSE update license and add AUTHORS file. Closes #386 2014-12-31 11:06:54 -08:00
Makefile add eslint and standard config 2015-10-13 09:23:06 +02:00
Readme.md refactor Application into a class 2015-10-13 01:19:42 -05:00
package.json add eslint and standard config 2015-10-13 09:23:06 +02: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 requires node v4.0.0 or higher for (partial) ES2015 support.

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

const Koa = require('koa');
const app = new Koa();

// logger

app.use(function *(next){
  const start = new Date;
  yield next;
  const ms = new Date - start;
  console.log(`${this.method} ${this.url} - ${ms}`);
});

// response

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

app.listen(3000);

Running tests

$ make test

Authors

See AUTHORS.

License

MIT