Skip to content

Commit 095794f

Browse files
aduh95targos
authored andcommitted
doc: add links to parent class for node:zlib classes
PR-URL: #58433 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
1 parent 7f1c95a commit 095794f

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
@@ -856,6 +856,8 @@ added:
856856
- v10.16.0
857857
-->
858858

859+
* Extends: [`ZlibBase`][]
860+
859861
Compress data using the Brotli algorithm.
860862

861863
## Class: `zlib.BrotliDecompress`
@@ -866,6 +868,8 @@ added:
866868
- v10.16.0
867869
-->
868870

871+
* Extends: [`ZlibBase`][]
872+
869873
Decompress data using the Brotli algorithm.
870874

871875
## Class: `zlib.Deflate`
@@ -874,6 +878,8 @@ Decompress data using the Brotli algorithm.
874878
added: v0.5.8
875879
-->
876880

881+
* Extends: [`ZlibBase`][]
882+
877883
Compress data using deflate.
878884

879885
## Class: `zlib.DeflateRaw`
@@ -882,6 +888,8 @@ Compress data using deflate.
882888
added: v0.5.8
883889
-->
884890

891+
* Extends: [`ZlibBase`][]
892+
885893
Compress data using deflate, and do not append a `zlib` header.
886894

887895
## Class: `zlib.Gunzip`
@@ -901,6 +909,8 @@ changes:
901909
description: A truncated input stream will now result in an `'error'` event.
902910
-->
903911

912+
* Extends: [`ZlibBase`][]
913+
904914
Decompress a gzip stream.
905915

906916
## Class: `zlib.Gzip`
@@ -909,6 +919,8 @@ Decompress a gzip stream.
909919
added: v0.5.8
910920
-->
911921

922+
* Extends: [`ZlibBase`][]
923+
912924
Compress data using gzip.
913925

914926
## Class: `zlib.Inflate`
@@ -921,6 +933,8 @@ changes:
921933
description: A truncated input stream will now result in an `'error'` event.
922934
-->
923935

936+
* Extends: [`ZlibBase`][]
937+
924938
Decompress a deflate stream.
925939

926940
## Class: `zlib.InflateRaw`
@@ -936,6 +950,8 @@ changes:
936950
description: A truncated input stream will now result in an `'error'` event.
937951
-->
938952

953+
* Extends: [`ZlibBase`][]
954+
939955
Decompress a raw deflate stream.
940956

941957
## Class: `zlib.Unzip`
@@ -944,6 +960,8 @@ Decompress a raw deflate stream.
944960
added: v0.5.8
945961
-->
946962

963+
* Extends: [`ZlibBase`][]
964+
947965
Decompress either a Gzip- or Deflate-compressed stream by auto-detecting
948966
the header.
949967

@@ -959,6 +977,8 @@ changes:
959977
description: This class was renamed from `Zlib` to `ZlibBase`.
960978
-->
961979

980+
* Extends: [`stream.Transform`][]
981+
962982
Not exported by the `node:zlib` module. It is documented here because it is the
963983
base class of the compressor/decompressor classes.
964984

@@ -1707,6 +1727,7 @@ Decompress a chunk of data with [`ZstdDecompress`][].
17071727
[`InflateRaw`]: #class-zlibinflateraw
17081728
[`Inflate`]: #class-zlibinflate
17091729
[`Unzip`]: #class-zlibunzip
1730+
[`ZlibBase`]: #class-zlibzlibbase
17101731
[`ZstdCompress`]: #class-zlibzstdcompress
17111732
[`ZstdDecompress`]: #class-zlibzstddecompress
17121733
[`buffer.kMaxLength`]: buffer.md#bufferkmaxlength

0 commit comments

Comments
 (0)