@@ -46,7 +46,7 @@ There are four fundamental stream types within Node.js:
46
46
* [ ` Transform ` ] [ ] - ` Duplex ` streams that can modify or transform the data as it
47
47
is written and read (for example, [ ` zlib.createDeflate() ` ] [ ] ).
48
48
49
- Additionally this module includes the utility functions [ pipeline] [ ] and
49
+ Additionally, this module includes the utility functions [ pipeline] [ ] and
50
50
[ finished] [ ] .
51
51
52
52
### Object Mode
@@ -97,7 +97,7 @@ is to limit the buffering of data to acceptable levels such that sources and
97
97
destinations of differing speeds will not overwhelm the available memory.
98
98
99
99
Because [ ` Duplex ` ] [ ] and [ ` Transform ` ] [ ] streams are both ` Readable ` and
100
- ` Writable ` , each maintain * two* separate internal buffers used for reading and
100
+ ` Writable ` , each maintains * two* separate internal buffers used for reading and
101
101
writing, allowing each side to operate independently of the other while
102
102
maintaining an appropriate and efficient flow of data. For example,
103
103
[ ` net.Socket ` ] [ ] instances are [ ` Duplex ` ] [ ] streams whose ` Readable ` side allows
@@ -388,7 +388,7 @@ changes:
388
388
not operating in object mode, ` chunk ` must be a string, ` Buffer ` or
389
389
` Uint8Array ` . For object mode streams, ` chunk ` may be any JavaScript value
390
390
other than ` null ` .
391
- * ` encoding ` {string} The encoding, if ` chunk ` is a string
391
+ * ` encoding ` {string} The encoding if ` chunk ` is a string
392
392
* ` callback ` {Function} Optional callback for when the stream is finished
393
393
* Returns: {this}
394
394
@@ -531,7 +531,7 @@ not draining may lead to a remotely exploitable vulnerability.
531
531
532
532
Writing data while the stream is not draining is particularly
533
533
problematic for a [ ` Transform ` ] [ ] , because the ` Transform ` streams are paused
534
- by default until they are piped or an ` 'data' ` or ` 'readable' ` event handler
534
+ by default until they are piped or a ` 'data' ` or ` 'readable' ` event handler
535
535
is added.
536
536
537
537
If the data to be written can be generated or fetched on demand, it is
@@ -610,7 +610,7 @@ until a mechanism for either consuming or ignoring that data is provided. If
610
610
the consuming mechanism is disabled or taken away, the ` Readable ` will * attempt*
611
611
to stop generating the data.
612
612
613
- For backwards compatibility reasons, removing [ ` 'data' ` ] [ ] event handlers will
613
+ For backward compatibility reasons, removing [ ` 'data' ` ] [ ] event handlers will
614
614
** not** automatically pause the stream. Also, if there are piped destinations,
615
615
then calling [ ` stream.pause() ` ] [ stream-pause ] will not guarantee that the
616
616
stream will * remain* paused once those destinations drain and ask for more data.
@@ -1342,7 +1342,7 @@ Especially useful in error handling scenarios where a stream is destroyed
1342
1342
prematurely (like an aborted HTTP request), and will not emit ` 'end' `
1343
1343
or ` 'finish' ` .
1344
1344
1345
- The ` finished ` API is promisify' able as well;
1345
+ The ` finished ` API is promisify- able as well;
1346
1346
1347
1347
``` js
1348
1348
const finished = util .promisify (stream .finished );
@@ -1394,7 +1394,7 @@ pipeline(
1394
1394
);
1395
1395
```
1396
1396
1397
- The ` pipeline ` API is promisify' able as well:
1397
+ The ` pipeline ` API is promisify- able as well:
1398
1398
1399
1399
``` js
1400
1400
const pipeline = util .promisify (stream .pipeline );
@@ -1866,7 +1866,7 @@ changes:
1866
1866
any JavaScript value.
1867
1867
* ` encoding ` {string} Encoding of string chunks. Must be a valid
1868
1868
` Buffer ` encoding, such as ` 'utf8' ` or ` 'ascii' ` .
1869
- * Returns: {boolean} ` true ` if additional chunks of data may continued to be
1869
+ * Returns: {boolean} ` true ` if additional chunks of data may continue to be
1870
1870
pushed; ` false ` otherwise.
1871
1871
1872
1872
When ` chunk ` is a ` Buffer ` , ` Uint8Array ` or ` string ` , the ` chunk ` of data will
@@ -2279,7 +2279,7 @@ The `callback` function must be called only when the current chunk is completely
2279
2279
consumed. The first argument passed to the ` callback ` must be an ` Error ` object
2280
2280
if an error occurred while processing the input or ` null ` otherwise. If a second
2281
2281
argument is passed to the ` callback ` , it will be forwarded on to the
2282
- ` readable.push() ` method. In other words the following are equivalent:
2282
+ ` readable.push() ` method. In other words, the following are equivalent:
2283
2283
2284
2284
``` js
2285
2285
transform .prototype ._transform = function (data , encoding , callback ) {
@@ -2326,7 +2326,7 @@ less powerful and less useful.
2326
2326
guaranteed. This meant that it was still necessary to be prepared to receive
2327
2327
[ ` 'data' ` ] [ ] events * even when the stream was in a paused state* .
2328
2328
2329
- In Node.js 0.10, the [ ` Readable ` ] [ ] class was added. For backwards
2329
+ In Node.js 0.10, the [ ` Readable ` ] [ ] class was added. For backward
2330
2330
compatibility with older Node.js programs, ` Readable ` streams switch into
2331
2331
"flowing mode" when a [ ` 'data' ` ] [ ] event handler is added, or when the
2332
2332
[ ` stream.resume() ` ] [ stream-resume ] method is called. The effect is that, even
0 commit comments