diff --git a/doc/api/zlib.md b/doc/api/zlib.md index a3695eb8991ece..e3fd89981c126a 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -856,6 +856,8 @@ added: - v10.16.0 --> +* Extends: [`ZlibBase`][] + Compress data using the Brotli algorithm. ## Class: `zlib.BrotliDecompress` @@ -866,6 +868,8 @@ added: - v10.16.0 --> +* Extends: [`ZlibBase`][] + Decompress data using the Brotli algorithm. ## Class: `zlib.Deflate` @@ -874,6 +878,8 @@ Decompress data using the Brotli algorithm. added: v0.5.8 --> +* Extends: [`ZlibBase`][] + Compress data using deflate. ## Class: `zlib.DeflateRaw` @@ -882,6 +888,8 @@ Compress data using deflate. added: v0.5.8 --> +* Extends: [`ZlibBase`][] + Compress data using deflate, and do not append a `zlib` header. ## Class: `zlib.Gunzip` @@ -901,6 +909,8 @@ changes: description: A truncated input stream will now result in an `'error'` event. --> +* Extends: [`ZlibBase`][] + Decompress a gzip stream. ## Class: `zlib.Gzip` @@ -909,6 +919,8 @@ Decompress a gzip stream. added: v0.5.8 --> +* Extends: [`ZlibBase`][] + Compress data using gzip. ## Class: `zlib.Inflate` @@ -921,6 +933,8 @@ changes: description: A truncated input stream will now result in an `'error'` event. --> +* Extends: [`ZlibBase`][] + Decompress a deflate stream. ## Class: `zlib.InflateRaw` @@ -936,6 +950,8 @@ changes: description: A truncated input stream will now result in an `'error'` event. --> +* Extends: [`ZlibBase`][] + Decompress a raw deflate stream. ## Class: `zlib.Unzip` @@ -944,6 +960,8 @@ Decompress a raw deflate stream. added: v0.5.8 --> +* Extends: [`ZlibBase`][] + Decompress either a Gzip- or Deflate-compressed stream by auto-detecting the header. @@ -959,6 +977,8 @@ changes: description: This class was renamed from `Zlib` to `ZlibBase`. --> +* Extends: [`stream.Transform`][] + Not exported by the `node:zlib` module. It is documented here because it is the base class of the compressor/decompressor classes. @@ -1707,6 +1727,7 @@ Decompress a chunk of data with [`ZstdDecompress`][]. [`InflateRaw`]: #class-zlibinflateraw [`Inflate`]: #class-zlibinflate [`Unzip`]: #class-zlibunzip +[`ZlibBase`]: #class-zlibzlibbase [`ZstdCompress`]: #class-zlibzstdcompress [`ZstdDecompress`]: #class-zlibzstddecompress [`buffer.kMaxLength`]: buffer.md#bufferkmaxlength