https://github.com/jayli/koa-stream-await-call-error

how to handle stream output with await & async.
https://github.com/jayli/koa-stream-await-call-error

Last synced: about 1 month ago
JSON representation

how to handle stream output with await & async.

• Host: GitHub
• URL: https://github.com/jayli/koa-stream-await-call-error
• Owner: jayli
• Created: 2020-10-02T16:36:42.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-11-05T04:27:19.000Z (about 4 years ago)
• Last Synced: 2024-04-15T13:55:28.164Z (9 months ago)
• Language: JavaScript
• Size: 31.3 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
There are some abnormal behavior when using stream with koa2 if you are not careful.

For example. When I want to print some messages one by one with a timmer. The following code does not work exactly as your wish.

    router.get('/wtf_with_await',async (ctx)=>{

        var stream = ctx.body = new Readable();

        stream._read = function () {};

        ctx.type = 'text/undefined-content';

        stream.push('begin Date() printing via timmer:\n\n');

        await repeat(stream); // print sth with timmer one by one

        stream.push('\nall done!\n');

        stream.push('\nWTF?~ There is only a one-time output!\n');

        stream.push(null);

    });

The above code only gives us a one-time output. You should add 'stream.pipe(ctx.res)' before 'stream.push' to make it work. Or you can use the callback form without await to avoid this problem.

Be careful. When you use promise callback form, please delete 'stream.pipe(ctx.res)' call. Because koa2 has done it for you. (See [koajs/koa/lib/application.js](https://github.com/koajs/koa/blob/master/lib/application.js#L267)). So pipe(ctx.res) call and promise callback form shouldn't exist at the same time. For example. If you want to implement some kind of stream proxy server. You should avoid using async/await function call.

Another way to fix it is not using "stream" at all. By setting `ctx.respond = false` you can simulate stream instead.

Take a look at the example by running [app.js](app.js):

    npm run start

See results:

- 

- 

- 

-