Skip to content
Browse files

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: #23246
Reviewed-By: Luigi Pinca <>
Reviewed-By: Vse Mozhet Byt <>
Reviewed-By: Colin Ihrig <>
Reviewed-By: Sakthipriyan Vairamani <>
  • Loading branch information
addaleax committed Oct 6, 2018
1 parent 48d1335 commit 6e43dfb6e3b17d26d927da40e1df8e2c1d07dc95
Showing with 6 additions and 2 deletions.
  1. +6 −2 doc/api/
@@ -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,

0 comments on commit 6e43dfb

Please sign in to comment.
You can’t perform that action at this time.