opl- / cottage Goto Github PK

Cottage is the fastest, simple, and intuitive HTTP router framework for Koa.js.

• Fastest HTTP Router / Framework on Node - See performance
• Simple code - Aren't you tired using res.send or ctx.body? Why can't we just return the response?
• Additional Sugar Features

Cottage requires Node v8.0.0 or higher.

$ npm install cottage

import { Cottage, Response } from 'cottage';
const app = new Cottage();

// just simple return would be enough
app.post('/', async ctx => 'Hello world!');

app.get('/auth', async ctx => {
    // needs fancy response code?
    return new Response(401, { error: 'unauthorized' });
});

// cottage is built on the top of Koa.
app.use(anyKoaMiddleware());
(new Koa).use(app.callback()).listen(...);

// or a simple shorthand without importing Koa.
app.listen(8080, () => console.log('Independent!'));

Benchmark have been ran on Intel Xeon E3-1250v3 @ 3.50ghz with Node.js 6.1.0 single instance. Tested from Github API sample using wrk

As the benchmark result shows, cottage is the fastest framework in Node.js.

Cottage uses Radix Tree for URL routing, which is faster than any other data structures. Also, cottage uses technique called "middleware precomposition", which precomposes middleware only at first time, not the every runtime.

• API Documentation
• Samples