@@ -79,7 +79,7 @@ queue until it is consumed.
79
79
Once the total size of the internal read buffer reaches the threshold specified
80
80
by ` highWaterMark ` , the stream will temporarily stop reading data from the
81
81
underlying resource until the data currently buffered can be consumed (that is,
82
- the stream will stop calling the internal ` readable._read() ` method that is
82
+ the stream will stop calling the internal [ ` readable._read() ` ] [ ] method that is
83
83
used to fill the read buffer).
84
84
85
85
Data is buffered in ` Writable ` streams when the
@@ -2017,7 +2017,7 @@ console.log(w.data); // currency: €
2017
2017
The ` stream.Readable ` class is extended to implement a [ ` Readable ` ] [ ] stream.
2018
2018
2019
2019
Custom ` Readable ` streams * must* call the ` new stream.Readable([options]) `
2020
- constructor and implement the ` readable._read() ` method.
2020
+ constructor and implement the [ ` readable._read() ` ] [ ] method.
2021
2021
2022
2022
#### ` new stream.Readable([options]) `
2023
2023
<!-- YAML
@@ -2097,27 +2097,27 @@ implemented by child classes, and called by the internal `Readable` class
2097
2097
methods only.
2098
2098
2099
2099
All ` Readable ` stream implementations must provide an implementation of the
2100
- ` readable._read() ` method to fetch data from the underlying resource.
2100
+ [ ` readable._read() ` ] [ ] method to fetch data from the underlying resource.
2101
2101
2102
- When ` readable._read() ` is called, if data is available from the resource, the
2103
- implementation should begin pushing that data into the read queue using the
2102
+ When [ ` readable._read() ` ] [ ] is called, if data is available from the resource,
2103
+ the implementation should begin pushing that data into the read queue using the
2104
2104
[ ` this.push(dataChunk) ` ] [ stream-push ] method. ` _read() ` should continue reading
2105
2105
from the resource and pushing data until ` readable.push() ` returns ` false ` . Only
2106
2106
when ` _read() ` is called again after it has stopped should it resume pushing
2107
2107
additional data onto the queue.
2108
2108
2109
- Once the ` readable._read() ` method has been called, it will not be called again
2110
- until more data is pushed through the [ ` readable.push() ` ] [ stream-push ] method.
2111
- Empty data such as empty buffers and strings will not cause ` readable._read() `
2112
- to be called.
2109
+ Once the [ ` readable._read() ` ] [ ] method has been called, it will not be called
2110
+ again until more data is pushed through the [ ` readable.push() ` ] [ stream-push ]
2111
+ method. Empty data such as empty buffers and strings will not cause
2112
+ [ ` readable._read() ` ] [ ] to be called.
2113
2113
2114
2114
The ` size ` argument is advisory. For implementations where a "read" is a
2115
2115
single operation that returns data can use the ` size ` argument to determine how
2116
2116
much data to fetch. Other implementations may ignore this argument and simply
2117
2117
provide data whenever it becomes available. There is no need to "wait" until
2118
2118
` size ` bytes are available before calling [ ` stream.push(chunk) ` ] [ stream-push ] .
2119
2119
2120
- The ` readable._read() ` method is prefixed with an underscore because it is
2120
+ The [ ` readable._read() ` ] [ ] method is prefixed with an underscore because it is
2121
2121
internal to the class that defines it, and should never be called directly by
2122
2122
user programs.
2123
2123
@@ -2200,7 +2200,7 @@ class SourceWrapper extends Readable {
2200
2200
```
2201
2201
2202
2202
The ` readable.push() ` method is used to push the content
2203
- into the internal buffer. It can be driven by the ` readable._read() ` method.
2203
+ into the internal buffer. It can be driven by the [ ` readable._read() ` ] [ ] method.
2204
2204
2205
2205
For streams not operating in object mode, if the ` chunk ` parameter of
2206
2206
` readable.push() ` is ` undefined ` , it will be treated as empty string or
@@ -2273,7 +2273,7 @@ both base classes due to overriding [`Symbol.hasInstance`][] on
2273
2273
` stream.Writable ` .
2274
2274
2275
2275
Custom ` Duplex ` streams * must* call the ` new stream.Duplex([options]) `
2276
- constructor and implement * both* the ` readable._read() ` and
2276
+ constructor and implement * both* the [ ` readable._read() ` ] [ ] and
2277
2277
` writable._write() ` methods.
2278
2278
2279
2279
#### ` new stream.Duplex(options) `
@@ -2436,10 +2436,10 @@ larger than its input.
2436
2436
The ` stream.Transform ` class is extended to implement a [ ` Transform ` ] [ ] stream.
2437
2437
2438
2438
The ` stream.Transform ` class prototypically inherits from ` stream.Duplex ` and
2439
- implements its own versions of the ` writable._write() ` and ` readable._read() `
2440
- methods. Custom ` Transform ` implementations * must* implement the
2441
- [ ` transform._transform() ` ] [ stream-_transform ] method and * may* also implement
2442
- the [ ` transform._flush() ` ] [ stream-_flush ] method.
2439
+ implements its own versions of the ` writable._write() ` and
2440
+ [ ` readable._read() ` ] [ ] methods. Custom ` Transform ` implementations * must*
2441
+ implement the [ ` transform._transform() ` ] [ stream-_transform ] method and * may*
2442
+ also implement the [ ` transform._flush() ` ] [ stream-_flush ] method.
2443
2443
2444
2444
Care must be taken when using ` Transform ` streams in that data written to the
2445
2445
stream can cause the ` Writable ` side of the stream to become paused if the
0 commit comments