Expressive middleware for node.js using ES2017 async functions, now with less dependancies
Find a file
Yiyu He b83405f052 Merge pull request from koajs/url
ensure parseurl always working as expected
2015-11-05 10:37:11 +08:00
benchmarks Update benchmark, remove --harmony flag and use arrow functions 2015-10-28 14:26:04 -07:00
docs Fix typo in example for Koa instantiation 2015-10-24 12:35:08 -07:00
lib ensure parseurl always working as expected 2015-11-04 15:08:49 +08:00
test ensure parseurl always working as expected 2015-11-04 15:08:49 +08:00
.editorconfig add editorconfig 2015-10-13 09:23:57 +02:00
.eslintrc eslint: add prefer-arrow-callback 2015-11-02 11:25:12 -08:00
.gitignore 0.14.0 2014-12-15 10:13:40 -08:00
.travis.yml Add node 5 to travis 2015-10-30 07:34:23 +01:00
AUTHORS update AUTHORS 2015-10-12 00:04:06 -07:00
History.md 2.0.0-alpha.2 2015-10-27 16:31:24 -07:00
LICENSE update license and add AUTHORS file. Closes 2014-12-31 11:06:54 -08:00
Makefile support async functions 2015-10-22 16:34:59 -07:00
package.json 2.0.0-alpha.2 2015-10-27 16:31:24 -07:00
Readme.md Add usage of koa-convert for legacy middleware 2015-10-30 20:20:00 -07:00

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((ctx, next) => {
  const start = new Date;
  return next().then(() => {
    const ms = new Date - start;
    console.log(`${ctx.method} ${ctx.url} - ${ms}`);
  });
});

// response

app.use(ctx => {
  ctx.body = 'Hello World';
});

app.listen(3000);

Example with async functions (Babel required)

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

// logger

app.use(async (ctx, next) => {
  const start = new Date;
  await next();
  const ms = new Date - start;
  console.log(`${ctx.method} ${ctx.url} - ${ms}`);
});

// response

app.use(ctx => {
  ctx.body = 'Hello World';
});

app.listen(3000);

Example with generator

To use generator functions, you must use a wrapper such as co that is no longer supplied with Koa.

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

// logger

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

// response

app.use(ctx => {
  ctx.body = 'Hello World';
});

app.listen(3000);

Example with old signature

If you want to use old signature or be compatible with old middleware, you must use koa-convert to convert legacy generator middleware to promise middleware.

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

// logger

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

// response

app.use(ctx => {
  ctx.body = 'Hello World';
});

app.listen(3000);

Running tests

$ make test

Authors

See AUTHORS.

License

MIT