0a223f2bb7
When calling `ctx.throw`, you're allowed to provide an error object and a status code. The status code is later set as the `status` property of the error object. If no status code is provided, it defaults to 500. However, this happens even if the error object already had a `status` property. This commit allows an error's pre-existing `status` property to be used in conjunction with `ctx.throw`. If the status code is below 500, the error message will be exposed to the user in the HTTP response. It would be nice to have some Error subclasses that always have the same status code, because then we could just write `ctx.throw(new WhateverError())`, and define which 4xx error code we want in the definition of `WhateverError` itself. If, for example, an `AuthenticationError` is always meant to go along with a 401, then it would be nice to just have that knowledge in the class definition. |
||
|---|---|---|
| benchmarks | ||
| docs | ||
| lib | ||
| test | ||
| .gitignore | ||
| .npmignore | ||
| .travis.yml | ||
| History.md | ||
| LICENSE | ||
| Makefile | ||
| Readme.md | ||
| index.js | ||
| package.json | ||
Readme.md
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 ~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.9 or higher for generator support, and must run node(1)
with the --harmony flag. If you don't like typing this, add an alias to your shell profile:
alias node='node --harmony'
Community
- API documentation
- Examples
- Middleware list
- Wiki
- G+ Community
- Mailing list
- Guide
- FAQ
- #koajs on freenode
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