Skip to content

Commit 5cc97df

Browse files
committed
doc: add links to parent class for node:zlib classes
PR-URL: #58433 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Juan José Arboleda <[email protected]>
1 parent d97616a commit 5cc97df

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

doc/api/zlib.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -854,6 +854,8 @@ added:
854854
- v10.16.0
855855
-->
856856

857+
* Extends: [`ZlibBase`][]
858+
857859
Compress data using the Brotli algorithm.
858860

859861
## Class: `zlib.BrotliDecompress`
@@ -864,6 +866,8 @@ added:
864866
- v10.16.0
865867
-->
866868

869+
* Extends: [`ZlibBase`][]
870+
867871
Decompress data using the Brotli algorithm.
868872

869873
## Class: `zlib.Deflate`
@@ -872,6 +876,8 @@ Decompress data using the Brotli algorithm.
872876
added: v0.5.8
873877
-->
874878

879+
* Extends: [`ZlibBase`][]
880+
875881
Compress data using deflate.
876882

877883
## Class: `zlib.DeflateRaw`
@@ -880,6 +886,8 @@ Compress data using deflate.
880886
added: v0.5.8
881887
-->
882888

889+
* Extends: [`ZlibBase`][]
890+
883891
Compress data using deflate, and do not append a `zlib` header.
884892

885893
## Class: `zlib.Gunzip`
@@ -899,6 +907,8 @@ changes:
899907
description: A truncated input stream will now result in an `'error'` event.
900908
-->
901909

910+
* Extends: [`ZlibBase`][]
911+
902912
Decompress a gzip stream.
903913

904914
## Class: `zlib.Gzip`
@@ -907,6 +917,8 @@ Decompress a gzip stream.
907917
added: v0.5.8
908918
-->
909919

920+
* Extends: [`ZlibBase`][]
921+
910922
Compress data using gzip.
911923

912924
## Class: `zlib.Inflate`
@@ -919,6 +931,8 @@ changes:
919931
description: A truncated input stream will now result in an `'error'` event.
920932
-->
921933

934+
* Extends: [`ZlibBase`][]
935+
922936
Decompress a deflate stream.
923937

924938
## Class: `zlib.InflateRaw`
@@ -934,6 +948,8 @@ changes:
934948
description: A truncated input stream will now result in an `'error'` event.
935949
-->
936950

951+
* Extends: [`ZlibBase`][]
952+
937953
Decompress a raw deflate stream.
938954

939955
## Class: `zlib.Unzip`
@@ -942,6 +958,8 @@ Decompress a raw deflate stream.
942958
added: v0.5.8
943959
-->
944960

961+
* Extends: [`ZlibBase`][]
962+
945963
Decompress either a Gzip- or Deflate-compressed stream by auto-detecting
946964
the header.
947965

@@ -957,6 +975,8 @@ changes:
957975
description: This class was renamed from `Zlib` to `ZlibBase`.
958976
-->
959977

978+
* Extends: [`stream.Transform`][]
979+
960980
Not exported by the `node:zlib` module. It is documented here because it is the
961981
base class of the compressor/decompressor classes.
962982

@@ -1701,6 +1721,7 @@ Decompress a chunk of data with [`ZstdDecompress`][].
17011721
[`InflateRaw`]: #class-zlibinflateraw
17021722
[`Inflate`]: #class-zlibinflate
17031723
[`Unzip`]: #class-zlibunzip
1724+
[`ZlibBase`]: #class-zlibzlibbase
17041725
[`ZstdCompress`]: #class-zlibzstdcompress
17051726
[`ZstdDecompress`]: #class-zlibzstddecompress
17061727
[`buffer.kMaxLength`]: buffer.md#bufferkmaxlength

0 commit comments

Comments
 (0)