doc: rename iterator to iterable in examples

ronag · MylesBorins · commit 0e48d8d855c0 · 2020-01-16T01:39:07.000-05:00
PR-URL: #31252 Fixes: #31222 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -2644,8 +2644,8 @@ const finished = util.promisify(stream.finished);
 
 const writable = fs.createWriteStream('./file');
 
-async function pump(iterator, writable) {
- for await (const chunk of iterator) {
+async function pump(iterable, writable) {
+ for await (const chunk of iterable) {
 // Handle backpressure on write().
 if (!writable.write(chunk)) {
 if (writable.destroyed) return;
@@ -2658,7 +2658,7 @@ async function pump(iterator, writable) {
 (async function() {
 // Ensure completion without errors.
 await Promise.all([
- pump(iterator, writable),
+ pump(iterable, writable),
 finished(writable)
 ]);
 })();
@@ -2682,7 +2682,7 @@ const finished = util.promisify(stream.finished);
 const writable = fs.createWriteStream('./file');
 
 (async function() {
- const readable = Readable.from(iterator);
+ const readable = Readable.from(iterable);
 readable.pipe(writable);
 // Ensure completion without errors.
 await finished(writable);
@@ -2697,7 +2697,7 @@ const pipeline = util.promisify(stream.pipeline);
 const writable = fs.createWriteStream('./file');
 
 (async function() {
- const readable = Readable.from(iterator);
+ const readable = Readable.from(iterable);
 await pipeline(readable, writable);
 })();
 ```

-Original file line number
+Diff line change
 constwritable=fs.createWriteStream('./file');
 -asyncfunctionpump(iterator, writable) {
 -forawait (constchunkofiterator) {
 +asyncfunctionpump(iterable, writable) {
 +forawait (constchunkofiterable) {
 // Handle backpressure on write().
 if (!writable.write(chunk)) {
 if (writable.destroyed) return;
 (asyncfunction() {
 // Ensure completion without errors.
 awaitPromise.all([
 -pump(iterator, writable),
 +pump(iterable, writable),
 finished(writable)
  ]);
 })();
 constwritable=fs.createWriteStream('./file');
 (asyncfunction() {
 -constreadable=Readable.from(iterator);
 +constreadable=Readable.from(iterable);
 readable.pipe(writable);
 // Ensure completion without errors.
 awaitfinished(writable);
 constwritable=fs.createWriteStream('./file');
 (asyncfunction() {
 -constreadable=Readable.from(iterator);
 +constreadable=Readable.from(iterable);
 awaitpipeline(readable, writable);
 })();
 ```