From eda2ba925a5883931eadcad525ebcbb8b8cd843d Mon Sep 17 00:00:00 2001 From: gyson Date: Thu, 22 Oct 2015 19:52:32 -0400 Subject: [PATCH] update README --- README.md | 45 +++++++++------------------------------------ 1 file changed, 9 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 5f1cdb6..f1ca41e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # koa-convert -Convert koa generator-based middleware to promise-based middleware. +Convert koa legacy ( v0.x & v1.x ) generator middleware to promise middleware ( v2.x ). ## Installation @@ -9,46 +9,19 @@ Convert koa generator-based middleware to promise-based middleware. $ npm install koa-convert ``` -## Related Issues - -* koa [#415](https://github.com/koajs/koa/issues/415) -* koa-compose [#27](https://github.com/koajs/compose/pull/27) - ## Usage ```js +const Koa = require('koa') // koa v2.x const convert = require('koa-convert') -// -// convert a generator-based middleware to promise-based middleware -// -let promiseBased = convert(function* generatorBased(next) { - yield next - // or - // yield* next -}) - -// -// convert array of middleware -// -let mws = [ - // will convert it to promise-based middleware - function* generatorMW (next) { - yield next - }, - // will convert it to promise-based middleware - function* generatorMW(next) { - yield* next - }, - // return itself if it's not generator-based middleware - function (ctx, next) { - return next() - }, - // return itself if it's not generator-based middleware - async function (ctx, next) { - await next() - }, -].map(convert) +let app = new Koa() + +app.use(convert(function* legacyMiddleware(next) { + // before + yield next + // after +})) ``` ## License