0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
nodejs/doc
Daniel George Holz fac11b05b7 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>
2019-01-20 22:58:38 +02:00
..
api doc: reword stream docs to clarify that decodeStrings encodes strings 2019-01-20 22:58:38 +02:00
api_assets doc: adjusting formatting when printing 2018-11-16 21:13:46 -08:00
changelogs 2019-01-17, Version 11.7.0 (Current), @BridgeAR 2019-01-18 14:03:19 +01:00
guides doc: update benchmark doc 2019-01-09 01:39:43 +01:00
.eslintrc.yaml
first_timer_badge.png
full-white-stripe.jpg
node.1 doc: add node-report documentation 2019-01-18 10:35:55 +05:30
offboarding.md
onboarding-extras.md
onboarding.md doc: fix author-ready conflict 2018-12-13 08:40:45 -08:00
osx_installer_logo.png
releases.md doc: add triaging section to releases.md 2018-12-04 18:37:16 -08:00
STYLE_GUIDE.md doc: add branding to style guide 2018-10-31 23:26:53 -07:00
template.html
thin-white-stripe.jpg