diff options
| author | Daniel George Holz <dgholz@gmail.com> | 2019-01-13 01:35:34 +0300 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2019-01-20 23:58:38 +0300 |
| commit | fac11b05b7fa36a936cce32f303a29dd093ac2dc (patch) | |
| tree | 50b64916d90a38f5a6a92b9427d800e3a07008d5 /BUILDING.md | |
| parent | 5571c0ddebe72e894e41bbee56c7165a55788288 (diff) | |
doc: reword stream docs to clarify that decodeStrings encodes strings
I was implementing a Writable stream and misunderstood `decodeStrings`
to mean 'will decode `Buffer`s into `string`s before calling `_write`'.
This change adds a little more detail to the description of
`decodeStrings` to clarify its effect on a Writable stream & what gets
passed to `_write`.
Changing the name of the option to `encodeStrings` would make it much
easier to understand, but the name was chosen in 2012 and the option
used in many projects (22k mentions of 'decodeStringsr in JS projects in
GitHub). Deprecating the old name & rolling out a replacement is beyond
my capabilities as a first-time contributor.
PR-URL: https://github.com/nodejs/node/pull/25468
Fixes: https://github.com/nodejs/node/issues/25464
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'BUILDING.md')
0 files changed, 0 insertions, 0 deletions