From a31de9e1831c0e7df48a6313deeeecb2bc5d01d6 Mon Sep 17 00:00:00 2001 From: Anna Henningsen Date: Wed, 3 Oct 2018 13:32:26 -0700 Subject: [PATCH] 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. --- doc/api/stream.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index 62bcfaedf59f35..4ec151a37c2cb8 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -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,