Commit a53f881
doc: update writable.write return value
Fix the explanation which stated that write() would return false if
highWaterMark is exceeded to correctly state that false is returned
once highWaterMark is reached. See #9247.
PR-URL: #10582
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>1 parent 6e1a3d1 commit a53f881
1 file changed
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -440,7 +440,7 @@ occurs, the `callback` *may or may not* be called with the error as its | |||
| 440 | 440 | first argument. To reliably detect write errors, add a listener for the | |
| 441 | 441 | `'error'` event. | |
| 442 | 442 | ||
| 443 | - The return value is `true` if the internal buffer does not exceed | ||
| 443 | + The return value is `true` if the internal buffer is less than the | ||
| 444 | 444 | `highWaterMark` configured when the stream was created after admitting `chunk`. | |
| 445 | 445 | If `false` is returned, further attempts to write data to the stream should | |
| 446 | 446 | stop until the [`'drain'`][] event is emitted. | |
0 commit comments