From 44d04a8c01dba1d7e4a9c9d9a4415eeacc580bf4 Mon Sep 17 00:00:00 2001 From: Andreas Girgensohn Date: Wed, 15 Aug 2018 23:03:15 -0700 Subject: doc: clarify documentation of pipes and zlib objects Document how pipes can be chained in readable.pipe(). Document that zlib.Zlib inherits from stream.Transform. PR-URL: https://github.com/nodejs/node/pull/22354 Fixes: https://github.com/nodejs/node/issues/22341 Reviewed-By: Vse Mozhet Byt Reviewed-By: James M Snell Reviewed-By: Luigi Pinca Reviewed-By: Ruben Bridgewater Reviewed-By: Trivikram Kamat --- doc/api/zlib.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/api/zlib.md') diff --git a/doc/api/zlib.md b/doc/api/zlib.md index 746058f5a3..8ec179ba4a 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -397,6 +397,9 @@ 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. +This class inherits from [`stream.Transform`][], allowing `zlib` objects to be +used in pipes and similar stream operations. + ### zlib.bytesRead