Skip to content

Commit abe3eda

Browse files
grantcarthewMylesBorins
authored andcommitted
doc: fix code examples in stream.md
* Replace `console.error()` with `console.log()`. * Fix case and punctuation in logged output. PR-URL: #24112 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
1 parent 2d6e942 commit abe3eda

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/api/stream.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ for (let i = 0; i < 100; i++) {
291291
}
292292
writer.end('This is the end\n');
293293
writer.on('finish', () => {
294-
console.error('All writes are now complete.');
294+
console.log('All writes are now complete.');
295295
});
296296
```
297297

@@ -309,7 +309,7 @@ a readable stream, adding this writable to its set of destinations.
309309
const writer = getWritableStreamSomehow();
310310
const reader = getReadableStreamSomehow();
311311
writer.on('pipe', (src) => {
312-
console.error('something is piping into the writer');
312+
console.log('Something is piping into the writer.');
313313
assert.equal(src, reader);
314314
});
315315
reader.pipe(writer);
@@ -334,7 +334,7 @@ This is also emitted in case this [`Writable`][] stream emits an error when a
334334
const writer = getWritableStreamSomehow();
335335
const reader = getReadableStreamSomehow();
336336
writer.on('unpipe', (src) => {
337-
console.error('Something has stopped piping into the writer.');
337+
console.log('Something has stopped piping into the writer.');
338338
assert.equal(src, reader);
339339
});
340340
reader.pipe(writer);
@@ -551,7 +551,7 @@ function write(data, cb) {
551551

552552
// Wait for cb to be called before doing any other write.
553553
write('hello', () => {
554-
console.log('write completed, do more writes now');
554+
console.log('Write completed, do more writes now.');
555555
});
556556
```
557557

@@ -1091,7 +1091,7 @@ const readable = getReadableStreamSomehow();
10911091
readable.setEncoding('utf8');
10921092
readable.on('data', (chunk) => {
10931093
assert.equal(typeof chunk, 'string');
1094-
console.log('got %d characters of string data', chunk.length);
1094+
console.log('Got %d characters of string data:', chunk.length);
10951095
});
10961096
```
10971097

@@ -1119,9 +1119,9 @@ const writable = fs.createWriteStream('file.txt');
11191119
// but only for the first second
11201120
readable.pipe(writable);
11211121
setTimeout(() => {
1122-
console.log('Stop writing to file.txt');
1122+
console.log('Stop writing to file.txt.');
11231123
readable.unpipe(writable);
1124-
console.log('Manually close the file stream');
1124+
console.log('Manually close the file stream.');
11251125
writable.end();
11261126
}, 1000);
11271127
```
@@ -1329,9 +1329,9 @@ const rs = fs.createReadStream('archive.tar');
13291329

13301330
finished(rs, (err) => {
13311331
if (err) {
1332-
console.error('Stream failed', err);
1332+
console.error('Stream failed.', err);
13331333
} else {
1334-
console.log('Stream is done reading');
1334+
console.log('Stream is done reading.');
13351335
}
13361336
});
13371337

@@ -1351,7 +1351,7 @@ const rs = fs.createReadStream('archive.tar');
13511351

13521352
async function run() {
13531353
await finished(rs);
1354-
console.log('Stream is done reading');
1354+
console.log('Stream is done reading.');
13551355
}
13561356

13571357
run().catch(console.error);
@@ -1386,9 +1386,9 @@ pipeline(
13861386
fs.createWriteStream('archive.tar.gz'),
13871387
(err) => {
13881388
if (err) {
1389-
console.error('Pipeline failed', err);
1389+
console.error('Pipeline failed.', err);
13901390
} else {
1391-
console.log('Pipeline succeeded');
1391+
console.log('Pipeline succeeded.');
13921392
}
13931393
}
13941394
);
@@ -1405,7 +1405,7 @@ async function run() {
14051405
zlib.createGzip(),
14061406
fs.createWriteStream('archive.tar.gz')
14071407
);
1408-
console.log('Pipeline succeeded');
1408+
console.log('Pipeline succeeded.');
14091409
}
14101410

14111411
run().catch(console.error);

0 commit comments

Comments
 (0)