summaryrefslogtreecommitdiff
path: root/doc/api/zlib.md
diff options
context:
space:
mode:
authorAlexander O'Mara <me@alexomara.com>2017-05-17 20:09:00 -0400
committerAnna Henningsen <anna@addaleax.net>2017-06-01 00:22:23 +0200
commite7100364f44d5d90f672c6bcf915eead99031748 (patch)
tree162261843ab8cbdd944ed122e44f1d12e54facef /doc/api/zlib.md
parentd0b1b52edba8a4815086a1fa5e978ceaa91f6d3a (diff)
downloadandroid-node-v8-e7100364f44d5d90f672c6bcf915eead99031748.tar.gz
android-node-v8-e7100364f44d5d90f672c6bcf915eead99031748.tar.bz2
android-node-v8-e7100364f44d5d90f672c6bcf915eead99031748.zip
zlib: expose amount of data read for engines
Added bytesRead property to Zlib engines Fixes: https://github.com/nodejs/node/issues/8874 PR-URL: https://github.com/nodejs/node/pull/13088 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Diffstat (limited to 'doc/api/zlib.md')
-rw-r--r--doc/api/zlib.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/api/zlib.md b/doc/api/zlib.md
index e97ba9cc83..f57b3d0599 100644
--- a/doc/api/zlib.md
+++ b/doc/api/zlib.md
@@ -386,6 +386,17 @@ added: v0.5.8
Not exported by the `zlib` module. It is documented here because it is the base
class of the compressor/decompressor classes.
+### zlib.bytesRead
+<!-- YAML
+added: REPLACEME
+-->
+
+* {number}
+
+The `zlib.bytesRead` property specifies the number of bytes read by the engine
+before the bytes are processed (compressed or decompressed, as appropriate for
+the derived class).
+
### zlib.flush([kind], callback)
<!-- YAML
added: v0.5.8