Skip to content

Commit b6803ef

Browse files
committed
doc: the description of readable.push() method
1 parent e078e48 commit b6803ef

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/api/stream.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2150,8 +2150,8 @@ class SourceWrapper extends Readable {
21502150
}
21512151
```
21522152

2153-
The `readable.push()` method is intended be called only by `Readable`
2154-
implementers, and only from within the `readable._read()` method.
2153+
The `readable.push()` method is used to push the content
2154+
into the internal buffer. It can be driven by the `readable._read()` method.
21552155

21562156
For streams not operating in object mode, if the `chunk` parameter of
21572157
`readable.push()` is `undefined`, it will be treated as empty string or

0 commit comments

Comments
 (0)