jiangcuo/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-05-10 05:30:00 +00:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity
49fd9c63d2
node/doc/api
History
Anna Henningsen 49fd9c63d2
zlib: use .bytesWritten instead of .bytesRead 
The introduction of `.bytesRead` to zlib streams was unfortunate,
because other streams in Node.js core use the exact opposite naming
of `.bytesRead` and `.bytesWritten`.

While one could see how the original naming makes sense in
a `Transform` stream context, we should try to work towards more
consistent APIs in core for these things.

This introduces `zlib.bytesWritten` and documentation-only deprecates
`zlib.bytesRead`.

PR-URL: https://github.com/nodejs/node/pull/19414
Refs: https://github.com/nodejs/node/issues/8874
Refs: https://github.com/nodejs/node/pull/13088
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-04-10 00:36:26 +02:00
..
_toc.md doc: add introduced_in metadata to _toc.md 2018-03-06 09:18:37 +01:00
addons.md doc: fix various nits 2018-04-04 13:45:39 +03:00
all.md doc: prepare for v8/V8 linting in doc text 2017-11-22 08:24:46 -08:00
assert.md doc: fix added value for assert module 2018-04-04 15:20:59 +02:00
async_hooks.md doc: fix various nits 2018-04-04 13:45:39 +03:00
buffer.md doc: improve buf.indexOf() documentation style 2018-04-09 15:20:03 -07:00
child_process.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
cli.md lib: ensure --check flag works with --require 2018-04-04 17:31:45 -07:00
cluster.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
console.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
crypto.md doc: fix API descriptions for OpenSSL-1.1.0 2018-04-10 06:45:45 +09:00
debugger.md doc: fix various nits 2018-04-04 13:45:39 +03:00
deprecations.md zlib: use .bytesWritten instead of .bytesRead 2018-04-10 00:36:26 +02:00
dgram.md doc: fix various nits 2018-04-04 13:45:39 +03:00
dns.md doc: fix various nits 2018-04-04 13:45:39 +03:00
documentation.md doc: replace to Node.js 2018-03-06 00:46:30 +09:00
domain.md doc: fix various nits 2018-04-04 13:45:39 +03:00
errors.md src: add error code helpers to src/node_errors.h 2018-04-07 17:15:03 +08:00
esm.md doc: fix various nits 2018-04-04 13:45:39 +03:00
events.md doc: add new documentation lint rule 2018-02-23 16:26:29 +00:00
fs.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
globals.md url: expose the WHATWG URL API globally 2018-01-31 16:00:51 +01:00
http2.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
http.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
https.md doc: add missing quotes in default string values 2018-04-09 17:01:29 +03:00
index.md doc: git mv to .md 2016-04-20 16:34:27 -07:00
inspector.md doc: unify property sections 2018-04-08 20:37:19 +03:00
intl.md doc: add RegExp Unicode Property Escapes to intl 2018-03-02 02:34:37 +02:00
modules.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
n-api.md n-api: add more int64_t tests 2018-04-08 11:31:12 -07:00
net.md doc: clarify lifecycle of domain sockets 2018-04-06 09:58:48 -07:00
os.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
path.md doc: fix various nits 2018-04-04 13:45:39 +03:00
perf_hooks.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
process.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
punycode.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
querystring.md doc,tools: formalize, unify, codify default values 2018-04-04 12:30:36 +03:00
readline.md doc: fix various nits 2018-04-04 13:45:39 +03:00
repl.md doc: add missing quotes in default string values 2018-04-09 17:01:29 +03:00
stream.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
string_decoder.md doc,tools: formalize, unify, codify default values 2018-04-04 12:30:36 +03:00
synopsis.md doc: be more explicit in the sypnosis 2018-02-07 15:06:14 +01:00
timers.md 2018-03-01, Version 9.7.0 (Current) 2018-03-01 20:47:02 +11:00
tls.md doc: fix API descriptions for OpenSSL-1.1.0 2018-04-10 06:45:45 +09:00
tracing.md perf_hooks,trace_events: emit perf milestone trace events 2018-03-16 10:54:05 -07:00
tty.md doc,tools: formalize, unify, codify default values 2018-04-04 12:30:36 +03:00
url.md doc: explain edge case when assigning port to url 2018-04-09 12:25:00 -07:00
util.md doc: fix some links 2018-04-07 12:43:19 +03:00
v8.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
vm.md doc: fix various nits 2018-04-04 13:45:39 +03:00
zlib.md zlib: use .bytesWritten instead of .bytesRead 2018-04-10 00:36:26 +02:00