Skip to content

Commit 61de26a

Browse files
rexagodcodebytere
authored andcommittedJun 22, 2020
doc: link readable._read in stream.md
Refs: #33715 PR-URL: #33767 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 76fe2a9 commit 61de26a

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed
 

‎doc/api/stream.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ queue until it is consumed.
7979
Once the total size of the internal read buffer reaches the threshold specified
8080
by `highWaterMark`, the stream will temporarily stop reading data from the
8181
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
8383
used to fill the read buffer).
8484

8585
Data is buffered in `Writable` streams when the
@@ -2099,7 +2099,7 @@ console.log(w.data); // currency: €
20992099
The `stream.Readable` class is extended to implement a [`Readable`][] stream.
21002100

21012101
Custom `Readable` streams *must* call the `new stream.Readable([options])`
2102-
constructor and implement the `readable._read()` method.
2102+
constructor and implement the [`readable._read()`][] method.
21032103

21042104
#### `new stream.Readable([options])`
21052105
<!-- YAML
@@ -2184,27 +2184,27 @@ implemented by child classes, and called by the internal `Readable` class
21842184
methods only.
21852185

21862186
All `Readable` stream implementations must provide an implementation of the
2187-
`readable._read()` method to fetch data from the underlying resource.
2187+
[`readable._read()`][] method to fetch data from the underlying resource.
21882188

2189-
When `readable._read()` is called, if data is available from the resource, the
2190-
implementation should begin pushing that data into the read queue using the
2189+
When [`readable._read()`][] is called, if data is available from the resource,
2190+
the implementation should begin pushing that data into the read queue using the
21912191
[`this.push(dataChunk)`][stream-push] method. `_read()` should continue reading
21922192
from the resource and pushing data until `readable.push()` returns `false`. Only
21932193
when `_read()` is called again after it has stopped should it resume pushing
21942194
additional data onto the queue.
21952195

2196-
Once the `readable._read()` method has been called, it will not be called again
2197-
until more data is pushed through the [`readable.push()`][stream-push] method.
2198-
Empty data such as empty buffers and strings will not cause `readable._read()`
2199-
to be called.
2196+
Once the [`readable._read()`][] method has been called, it will not be called
2197+
again until more data is pushed through the [`readable.push()`][stream-push]
2198+
method. Empty data such as empty buffers and strings will not cause
2199+
[`readable._read()`][] to be called.
22002200

22012201
The `size` argument is advisory. For implementations where a "read" is a
22022202
single operation that returns data can use the `size` argument to determine how
22032203
much data to fetch. Other implementations may ignore this argument and simply
22042204
provide data whenever it becomes available. There is no need to "wait" until
22052205
`size` bytes are available before calling [`stream.push(chunk)`][stream-push].
22062206

2207-
The `readable._read()` method is prefixed with an underscore because it is
2207+
The [`readable._read()`][] method is prefixed with an underscore because it is
22082208
internal to the class that defines it, and should never be called directly by
22092209
user programs.
22102210

@@ -2287,7 +2287,7 @@ class SourceWrapper extends Readable {
22872287
```
22882288

22892289
The `readable.push()` method is used to push the content
2290-
into the internal buffer. It can be driven by the `readable._read()` method.
2290+
into the internal buffer. It can be driven by the [`readable._read()`][] method.
22912291

22922292
For streams not operating in object mode, if the `chunk` parameter of
22932293
`readable.push()` is `undefined`, it will be treated as empty string or
@@ -2360,7 +2360,7 @@ both base classes due to overriding [`Symbol.hasInstance`][] on
23602360
`stream.Writable`.
23612361

23622362
Custom `Duplex` streams *must* call the `new stream.Duplex([options])`
2363-
constructor and implement *both* the `readable._read()` and
2363+
constructor and implement *both* the [`readable._read()`][] and
23642364
`writable._write()` methods.
23652365

23662366
#### `new stream.Duplex(options)`
@@ -2523,10 +2523,10 @@ larger than its input.
25232523
The `stream.Transform` class is extended to implement a [`Transform`][] stream.
25242524

25252525
The `stream.Transform` class prototypically inherits from `stream.Duplex` and
2526-
implements its own versions of the `writable._write()` and `readable._read()`
2527-
methods. Custom `Transform` implementations *must* implement the
2528-
[`transform._transform()`][stream-_transform] method and *may* also implement
2529-
the [`transform._flush()`][stream-_flush] method.
2526+
implements its own versions of the `writable._write()` and
2527+
[`readable._read()`][] methods. Custom `Transform` implementations *must*
2528+
implement the [`transform._transform()`][stream-_transform] method and *may*
2529+
also implement the [`transform._flush()`][stream-_flush] method.
25302530

25312531
Care must be taken when using `Transform` streams in that data written to the
25322532
stream can cause the `Writable` side of the stream to become paused if the

0 commit comments

Comments
 (0)
Please sign in to comment.