doc: add print results for examples in `WebStreams` #49143

pluris · 2023-08-13T16:32:55Z

As with the other examples, I added something about the resulting output.(Only output results that do not change)

lpinca · 2023-08-14T19:07:59Z

doc/api/webstreams.md

@@ -248,6 +248,7 @@ const transformedStream = stream.pipeThrough(transform);

 for await (const chunk of transformedStream)
  console.log(chunk);
+  // Prints A


Suggested change

// Prints A

// Prints: A

lpinca · 2023-08-14T19:08:07Z

doc/api/webstreams.md

@@ -273,6 +274,7 @@ const transformedStream = stream.pipeThrough(transform);
 (async () => {
  for await (const chunk of transformedStream)
    console.log(chunk);
+    // Prints A


Suggested change

// Prints A

// Prints: A

lpinca · 2023-08-14T19:08:16Z

doc/api/webstreams.md

@@ -1520,6 +1522,7 @@ const dataArray = encoder.encode('hello world from consumers!');
 const readable = Readable.from(dataArray);
 const data = await arrayBuffer(readable);
 console.log(`from readable: ${data.byteLength}`);
+// Prints from readable: 76


Suggested change

// Prints from readable: 76

// Prints: from readable: 76

lpinca · 2023-08-14T19:08:25Z

doc/api/webstreams.md

@@ -1532,6 +1535,7 @@ const dataArray = encoder.encode('hello world from consumers!');
 const readable = Readable.from(dataArray);
 arrayBuffer(readable).then((data) => {
  console.log(`from readable: ${data.byteLength}`);
+  // Prints from readable: 76


Suggested change

// Prints from readable: 76

// Prints: from readable: 76

lpinca · 2023-08-14T19:08:37Z

doc/api/webstreams.md

@@ -1553,6 +1557,7 @@ const dataBlob = new Blob(['hello world from consumers!']);
 const readable = dataBlob.stream();
 const data = await blob(readable);
 console.log(`from readable: ${data.size}`);
+// Prints from readable: 27


Suggested change

// Prints from readable: 27

// Prints: from readable: 27

lpinca · 2023-08-14T19:09:06Z

doc/api/webstreams.md

@@ -1598,6 +1605,7 @@ const dataBuffer = Buffer.from('hello world from consumers!');
 const readable = Readable.from(dataBuffer);
 buffer(readable).then((data) => {
  console.log(`from readable: ${data.length}`);
+  // Prints from readable: 27


Suggested change

// Prints from readable: 27

// Prints: from readable: 27

lpinca · 2023-08-14T19:09:15Z

doc/api/webstreams.md

@@ -1627,6 +1635,7 @@ const items = Array.from(
 const readable = Readable.from(JSON.stringify(items));
 const data = await json(readable);
 console.log(`from readable: ${data.length}`);
+// Prints from readable: 100


Suggested change

// Prints from readable: 100

// Prints: from readable: 100

lpinca · 2023-08-14T19:09:22Z

doc/api/webstreams.md

@@ -1645,6 +1654,7 @@ const items = Array.from(
 const readable = Readable.from(JSON.stringify(items));
 json(readable).then((data) => {
  console.log(`from readable: ${data.length}`);
+  // Prints from readable: 100


Suggested change

// Prints from readable: 100

// Prints: from readable: 100

lpinca · 2023-08-14T19:09:30Z

doc/api/webstreams.md

@@ -1665,6 +1675,7 @@ import { Readable } from 'node:stream';
 const readable = Readable.from('Hello world from consumers!');
 const data = await text(readable);
 console.log(`from readable: ${data.length}`);
+// Prints from readable: 27


Suggested change

// Prints from readable: 27

// Prints: from readable: 27

lpinca · 2023-08-14T19:09:37Z

doc/api/webstreams.md

@@ -1674,6 +1685,7 @@ const { Readable } = require('node:stream');
 const readable = Readable.from('Hello world from consumers!');
 text(readable).then((data) => {
  console.log(`from readable: ${data.length}`);
+  // Prints from readable: 27


Suggested change

// Prints from readable: 27

// Prints: from readable: 27

lpinca · 2023-08-14T19:10:58Z

$ git grep "// Prints:" doc/ | wc -l
     505
$ git grep "// Prints " doc/ | wc -l
     115

pluris · 2023-08-15T01:43:24Z

@lpinca Hi, thank you for your opinion.
They are mixed in both ways, but most of them use Prints: more.
I think the document I referenced wrote Prints. 😓
I fixed it.

nodejs-github-bot · 2023-08-15T16:41:16Z

Landed in 9a2e6bc

PR-URL: #49143 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: nodejs#49143 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: #49143 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: #49326 Refs: #49143 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: nodejs#49326 Refs: nodejs#49143 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: #49326 Refs: #49143 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: nodejs/node#49326 Refs: nodejs/node#49143 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

doc: add print results for examples in WebStreams

5ba2918

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Aug 13, 2023

aduh95 approved these changes Aug 14, 2023

View reviewed changes

aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Aug 14, 2023

deokjinkim approved these changes Aug 14, 2023

View reviewed changes

lpinca approved these changes Aug 14, 2023

View reviewed changes

fixup! doc: add print results for examples in WebStreams

36ef98a

deokjinkim approved these changes Aug 15, 2023

View reviewed changes

lpinca added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Aug 15, 2023

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 15, 2023

nodejs-github-bot merged commit 9a2e6bc into nodejs:main Aug 15, 2023
17 checks passed

UlisesGascon mentioned this pull request Aug 15, 2023

v20.6.0 proposal #49185

Merged

pluris mentioned this pull request Aug 25, 2023

doc: add print results for examples in StringDecoder #49326

Merged

pluris deleted the fix/missing_prints_webstream branch August 30, 2023 16:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add print results for examples in `WebStreams` #49143

doc: add print results for examples in `WebStreams` #49143

pluris commented Aug 13, 2023

lpinca Aug 14, 2023

lpinca Aug 14, 2023

lpinca Aug 14, 2023

lpinca Aug 14, 2023

lpinca Aug 14, 2023

lpinca Aug 14, 2023

lpinca Aug 14, 2023

lpinca Aug 14, 2023

lpinca Aug 14, 2023

lpinca Aug 14, 2023

lpinca commented Aug 14, 2023

pluris commented Aug 15, 2023

nodejs-github-bot commented Aug 15, 2023

doc: add print results for examples in WebStreams #49143

doc: add print results for examples in WebStreams #49143

Conversation

pluris commented Aug 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lpinca commented Aug 14, 2023

pluris commented Aug 15, 2023

nodejs-github-bot commented Aug 15, 2023

doc: add print results for examples in `WebStreams` #49143

doc: add print results for examples in `WebStreams` #49143