Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 2.71 KB

Readme.md

File metadata and controls

76 lines (53 loc) · 2.71 KB

co-express is an express wrapper that enables generators to be used as middlewares.

NPM version Build Status Dependency Status devDependency Status

Usage

co-express lets you write your express routes by using generator functions as middlewares. Like this:

var fs = require('mz/fs');
var express = require('express');
var wrap = require('co-express');

var app = express();

app.get('/', wrap(function* (req, res) {
  var packageContents = yield fs.readFile('./package.json', 'utf8');
  res.send(packageContents);
}));

app.listen(8000);

You can also define multiple generator functions just the express way, as long as you wrap them and call next():

app.get('/users', wrap(function* (req, res, next) {
  req.users = yield db.getUsers();
  next();
}), wrap(function* (req, res) {
  res.send(req.users);
}));

Usage with other libraries

Starting from v2, you can pass your own wrapper function as a second argument.

This argument will be used instead of co.wrap.

The support of this wrapper library when used with this extra argument is untested and may vary from library to library.

Installation

$ npm install co-express

License

(The MIT License)

Copyright (c) 2013 Martín Ciparelli <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.