doc: improve stream.Writable
ctor encoding option docs
- Document `defaultEncoding`. This was previously undocumented. - Clarify `decodeStrings`. In particular, the previous description was talking about decoding, which matches the unfortunate option name, but what actually happens is usually refererred to as encoding a string into a binary form. PR-URL: https://github.com/nodejs/node/pull/23246 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
This commit is contained in:
parent
48d1335bbc
commit
6e43dfb6e3
@ -1500,9 +1500,13 @@ changes:
|
||||
* `highWaterMark` {number} Buffer level when
|
||||
[`stream.write()`][stream-write] starts returning `false`. **Default:**
|
||||
`16384` (16kb), or `16` for `objectMode` streams.
|
||||
* `decodeStrings` {boolean} Whether or not to decode strings into
|
||||
`Buffer`s before passing them to [`stream._write()`][stream-_write].
|
||||
* `decodeStrings` {boolean} Whether or not to encode strings as
|
||||
`Buffer`s before passing them to [`stream._write()`][stream-_write],
|
||||
using the encoding specified in the [`stream.write()`][stream-write] call.
|
||||
**Default:** `true`.
|
||||
* `defaultEncoding` {string} The default encoding that is used when no
|
||||
encoding is specified as an argument to [`stream.write()`][stream-write].
|
||||
**Default:** `'utf8'`.
|
||||
* `objectMode` {boolean} Whether or not the
|
||||
[`stream.write(anyObj)`][stream-write] is a valid operation. When set,
|
||||
it becomes possible to write JavaScript values other than string,
|
||||
|
Loading…
x
Reference in New Issue
Block a user