doc: add links to parent class for `node:zlib` classes · nodejs/node@5cc97df · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 633
• Pull requests 759
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 5cc97df

Browse filesBrowse the repository at this point in the historyBrowse files

aduh95

committed

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 d97616a commit 5cc97df
Copy full SHA for 5cc97df

1 file changed

+21Lines changed: 21 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • zlib.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/zlib.md‎

Copy file name to clipboardExpand all lines: doc/api/zlib.md

+21Lines changed: 21 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -854,6 +854,8 @@ added:
854	854	- v10.16.0
855	855	-->
856	856
	857	+ * Extends: [`ZlibBase`][]
	858	+
857	859	Compress data using the Brotli algorithm.
858	860
859	861	## Class: `zlib.BrotliDecompress`
@@ -864,6 +866,8 @@ added:
864	866	- v10.16.0
865	867	-->
866	868
	869	+ * Extends: [`ZlibBase`][]
	870	+
867	871	Decompress data using the Brotli algorithm.
868	872
869	873	## Class: `zlib.Deflate`
@@ -872,6 +876,8 @@ Decompress data using the Brotli algorithm.
872	876	added: v0.5.8
873	877	-->
874	878
	879	+ * Extends: [`ZlibBase`][]
	880	+
875	881	Compress data using deflate.
876	882
877	883	## Class: `zlib.DeflateRaw`
@@ -880,6 +886,8 @@ Compress data using deflate.
880	886	added: v0.5.8
881	887	-->
882	888
	889	+ * Extends: [`ZlibBase`][]
	890	+
883	891	Compress data using deflate, and do not append a `zlib` header.
884	892
885	893	## Class: `zlib.Gunzip`
@@ -899,6 +907,8 @@ changes:
899	907	description: A truncated input stream will now result in an `'error'` event.
900	908	-->
901	909
	910	+ * Extends: [`ZlibBase`][]
	911	+
902	912	Decompress a gzip stream.
903	913
904	914	## Class: `zlib.Gzip`
@@ -907,6 +917,8 @@ Decompress a gzip stream.
907	917	added: v0.5.8
908	918	-->
909	919
	920	+ * Extends: [`ZlibBase`][]
	921	+
910	922	Compress data using gzip.
911	923
912	924	## Class: `zlib.Inflate`
@@ -919,6 +931,8 @@ changes:
919	931	description: A truncated input stream will now result in an `'error'` event.
920	932	-->
921	933
	934	+ * Extends: [`ZlibBase`][]
	935	+
922	936	Decompress a deflate stream.
923	937
924	938	## Class: `zlib.InflateRaw`
@@ -934,6 +948,8 @@ changes:
934	948	description: A truncated input stream will now result in an `'error'` event.
935	949	-->
936	950
	951	+ * Extends: [`ZlibBase`][]
	952	+
937	953	Decompress a raw deflate stream.
938	954
939	955	## Class: `zlib.Unzip`
@@ -942,6 +958,8 @@ Decompress a raw deflate stream.
942	958	added: v0.5.8
943	959	-->
944	960
	961	+ * Extends: [`ZlibBase`][]
	962	+
945	963	Decompress either a Gzip- or Deflate-compressed stream by auto-detecting
946	964	the header.
947	965
@@ -957,6 +975,8 @@ changes:
957	975	description: This class was renamed from `Zlib` to `ZlibBase`.
958	976	-->
959	977
	978	+ * Extends: [`stream.Transform`][]
	979	+
960	980	Not exported by the `node:zlib` module. It is documented here because it is the
961	981	base class of the compressor/decompressor classes.
962	982
@@ -1701,6 +1721,7 @@ Decompress a chunk of data with [`ZstdDecompress`][].
1701	1721	[`InflateRaw`]: #class-zlibinflateraw
1702	1722	[`Inflate`]: #class-zlibinflate
1703	1723	[`Unzip`]: #class-zlibunzip
	1724	+ [`ZlibBase`]: #class-zlibzlibbase
1704	1725	[`ZstdCompress`]: #class-zlibzstdcompress
1705	1726	[`ZstdDecompress`]: #class-zlibzstddecompress
1706	1727	[`buffer.kMaxLength`]: buffer.md#bufferkmaxlength

0 commit comments

Comments

0 (0)