Add `.throw` and `.return` interface methods to StreamToAsyncIterator #1

basicdays · 2017-01-19T22:51:24Z

Generators can also provide methods to implement a return and throw feature to help handle additional syntax operators in a for-of loop.

For example:

const readStream = fs.createReadStream(__filename);
    for await (const chunk of new S2A(readStream)) {
        console.log(chunk);
        if (chunk === ...) break;
    }

This is how it is used within a vanilla generator:

function* gen(){
  try {
    for (var i = 0;; i++) yield i;
  } finally {
    console.log('done');
  }
}

for (var i of gen()) {
  if (i > 5) break;
}

basicdays · 2017-01-19T23:02:37Z

This is a decent mention of how these features could work in an interator: http://jsrocks.org/2015/09/javascript-iterables-and-iterators/#optional-iterator-methods

This is how Babel transpiles generators to use the optional methods: http://babeljs.io/repl/#?babili=false&evaluate=true&lineWrap=false&presets=es2015&experimental=false&loose=false&spec=false&playground=true&code=%0Afor%20(var%20i%20of%20gen())%7B%0A%20%20%0A%7D&runtime=true

- Breaking Change: Dropping support for Node 11 and below. - Breaking Change: Dropping support for Flow. - Bug Fix: Resolves #5. Event handlers are cleaned up after each iteration, fixing some memory leak issues. - Bug Fix: Resolves #7. Code no longer depends on babel runtimes or regenerator. - Bug Fix: Handles stream not buffering due to starving the event loop. - Feature: Resolves #1. Now handles `.throw` and `.return` hooks on the async iterator. - Feature: Properly closes stream when finished. - Feature: Added support for TypeScript. - Feature: Support for Node.js versions 12, 14, and 16. - Chore: General overhaul of project setup (should not impact what is published).

basicdays added the enhancement label Jan 20, 2017

basicdays mentioned this issue Mar 16, 2022

Overhaul and update project #11

Merged

basicdays closed this as completed in #11 Mar 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `.throw` and `.return` interface methods to StreamToAsyncIterator #1

Add `.throw` and `.return` interface methods to StreamToAsyncIterator #1

Add .throw and .return interface methods to StreamToAsyncIterator #1

Add .throw and .return interface methods to StreamToAsyncIterator #1

Comments

Add `.throw` and `.return` interface methods to StreamToAsyncIterator #1

Add `.throw` and `.return` interface methods to StreamToAsyncIterator #1