diff options
| author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-02 17:35:56 +0300 |
|---|---|---|
| committer | Gibson Fahnestock <gibfahn@gmail.com> | 2018-04-11 12:37:34 +0300 |
| commit | c89781583bb53389f0881a166beb7e2d0e59a194 (patch) | |
| tree | f2b53864b21a5eb24f223470d645aad434693dbd /doc/api/stream.md | |
| parent | 333d7dda84447e30d9f27d5b66fd7e30f54d226f (diff) | |
doc: fix various nits
* Replace 2 hyphens (--) by spaced m-dashes (—) as per STYLE_GUIDE.md.
* Space infix operators.
* Unify quotes in inline code spans (use only single quotes).
* Unify `* Returns:` (eliminate deviations).
* Dedupe spaces.
PR-URL: https://github.com/nodejs/node/pull/19743
Backport-PR-URL: https://github.com/nodejs/node/pull/19753
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
| -rw-r--r-- | doc/api/stream.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 74173abe34f..aed4a1fd90e 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -901,7 +901,7 @@ added: v0.9.4 --> * `size` {number} Optional argument to specify how much data to read. -* Return {string|Buffer|null} +* Returns: {string|Buffer|null} The `readable.read()` method pulls some data out of the internal buffer and returns it. If no data available to be read, `null` is returned. By default, @@ -1482,7 +1482,7 @@ It is recommended that errors occurring during the processing of the the callback and passing the error as the first argument. This will cause an `'error'` event to be emitted by the Writable. Throwing an Error from within `writable._write()` can result in unexpected and inconsistent behavior depending -on how the stream is being used. Using the callback ensures consistent and +on how the stream is being used. Using the callback ensures consistent and predictable handling of errors. ```js @@ -1684,7 +1684,7 @@ changes: read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any JavaScript value. -* `encoding` {string} Encoding of string chunks. Must be a valid +* `encoding` {string} Encoding of string chunks. Must be a valid Buffer encoding, such as `'utf8'` or `'ascii'` * Returns: {boolean} `true` if additional chunks of data may continued to be pushed; `false` otherwise. @@ -2117,7 +2117,7 @@ The `transform._transform()` method is prefixed with an underscore because it is internal to the class that defines it, and should never be called directly by user programs. -`transform._transform()` is never called in parallel; streams implement a +`transform._transform()` is never called in parallel; streams implement a queue mechanism, and to receive the next chunk, `callback` must be called, either synchronously or asynchronously. |