0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
nodejs/doc/api
Jessica Quynh Tran 89f207499a
doc: document bytes to chars after setEncoding
This commit documents and edge-case behavior in readable streams.
It is expected that non-object streams are measured in bytes
against the highWaterMark. However, it was discovered in issue
thereafter begin to measure the buffer's length in characters.

PR-URL: https://github.com/nodejs/node/pull/13442
Refs: https://github.com/nodejs/node/issues/6798
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2017-09-07 23:22:12 -03:00
..
_toc.md perf_hooks: implementation of the perf timing API 2017-08-23 16:00:09 -07:00
addons.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
all.md perf_hooks: implementation of the perf timing API 2017-08-23 16:00:09 -07:00
assert.md assert: use SameValueZero in deepStrictEqual 2017-09-05 08:15:33 -03:00
async_hooks.md doc: fix link in async_hooks.md 2017-06-26 22:41:01 +03:00
buffer.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
child_process.md doc,lib,src,test: strip executable bits off files 2017-09-01 10:09:41 -07:00
cli.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
cluster.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
console.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
crypto.md doc: add options argument to crypto docs 2017-09-07 13:13:24 +02:00
debugger.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
deprecations.md doc: clarify async/asynchronous in deprecations.md 2017-09-05 12:38:40 -07:00
dgram.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
dns.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
documentation.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
domain.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
errors.md doc: document missing error codes 2017-09-07 22:01:02 -03:00
esm.md module: Allow runMain to be ESM 2017-09-07 15:18:32 -05:00
events.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
fs.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
globals.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
http2.md doc: readFileSync instead of fs.readFileSync 2017-09-01 17:14:21 -04:00
http.md net: multiple listen() events fail silently 2017-09-04 12:41:54 +02:00
https.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
index.md doc: git mv to .md 2016-04-20 16:34:27 -07:00
inspector.md doc: fix some broken references 2017-07-02 21:44:46 +02:00
intl.md doc: environmental->environment & NodeJS->Node.js 2017-08-24 15:17:29 -07:00
modules.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
n-api.md n-api: adds function to adjust external memory 2017-08-30 22:27:11 +03:00
net.md net: multiple listen() events fail silently 2017-09-04 12:41:54 +02:00
os.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
path.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
perf_hooks.md doc,lib,src,test: strip executable bits off files 2017-09-01 10:09:41 -07:00
process.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
punycode.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
querystring.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
readline.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
repl.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
stream.md doc: document bytes to chars after setEncoding 2017-09-07 23:22:12 -03:00
string_decoder.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
synopsis.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
timers.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
tls.md tls: multiple PFX in createSecureContext 2017-09-07 21:48:46 -03:00
tracing.md src: Node Tracing Controller 2016-12-20 12:31:09 -08:00
tty.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
url.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
util.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
v8.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
vm.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
zlib.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00