https://github.com/yourtion/express-coroutine
Generator function and Async function to be used as middlewares in express like koa.
https://github.com/yourtion/express-coroutine
async async-await async-functions coroutine express generator koa middleware promise yield
Last synced: 4 days ago
JSON representation
Generator function and Async function to be used as middlewares in express like koa.
- Host: GitHub
- URL: https://github.com/yourtion/express-coroutine
- Owner: yourtion
- License: mit
- Created: 2017-02-07T01:52:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-23T12:15:16.000Z (almost 5 years ago)
- Last Synced: 2025-05-12T04:56:01.572Z (4 days ago)
- Topics: async, async-await, async-functions, coroutine, express, generator, koa, middleware, promise, yield
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/express-coroutine
- Size: 85 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![David deps][david-image]][david-url]
[![node version][node-image]][node-url]
[![npm download][download-image]][download-url]
[![npm license][license-image]][download-url]
[](https://greenkeeper.io/)
[npm-image]: https://img.shields.io/npm/v/express-coroutine.svg?style=flat-square
[npm-url]: https://npmjs.org/package/express-coroutine
[travis-image]: https://img.shields.io/travis/yourtion/express-coroutine.svg?style=flat-square
[travis-url]: https://travis-ci.org/yourtion/express-coroutine
[coveralls-image]: https://img.shields.io/coveralls/yourtion/express-coroutine.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/yourtion/express-coroutine?branch=master
[david-image]: https://img.shields.io/david/yourtion/express-coroutine.svg?style=flat-square
[david-url]: https://david-dm.org/yourtion/express-coroutine
[node-image]: https://img.shields.io/badge/node.js-%3E=4.0-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/express-coroutine.svg?style=flat-square
[download-url]: https://npmjs.org/package/express-coroutine
[license-image]: https://img.shields.io/npm/l/express-coroutine.svg
# express-coroutine
Generator function and Async function to be used as middlewares in express like koa. ( use [lei-coroutine](https://github.com/leizongmin/lei-coroutine) )
## Installation
```bash
npm install express-coroutine --save
```
## Usage
### Init express
```javascript
const express = require('express-coroutine')(require('express'));
const app = express();
```
### Init router
```javascript
const express = require('express-coroutine')(require('express'));
const app = express();
const router = new express.Router();
app.use(router);
router.get('/', function* (req, res) {
res.send('it works!');
});
// also async function
router.get('/', async function (req, res) {
res.send('it works!');
});
```
Write your express routes by using generator functions as middlewares.
```javascript
const express = require('express-coroutine')(require('express'));
const app = express();
app.get('/user/:id', function* (req, res) {
const user = yield User.findById(req.params.id);
res.send(user);
})
app.get('/error', function* (req, res) {
throw new Error('Bang!');
});
// also async function
app.get('/user2/:id', async function* (req, res) {
const user = await User.findById(req.params.id);
res.send(user);
});
app.listen(8000);
```
You can also define multiple generator functions just the express way.
```javascript
const fn = function (req, res, next) {
return new Promise((resolve, reject) => {
if (req.params.user !== 'a') return reject(new Error('Bang!'));
resolve('a');
});
};
const middleware = function* (req, res, next) {
yield fn(req, res, next);
};
const middleware2 = async function (req, res, next) {
await fn(req, res, next);
next();
};
app.get('/:user', middleware, function* (req, res) {
res.send('it works!');
});
app.get('/:user', middleware2, async function (req, res) {
res.send('it works!');
});
```
More detail demo can be found in [test.js](test.js)
### Get coroutine
```javascript
const coroutine = require('express-coroutine').coroutine;
```