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

nodejs / node Public

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

• Code
• Issues 635
• Pull requests 756
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 095794f

Browse filesBrowse the repository at this point in the historyBrowse files

aduh95

authored and

targos

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 7f1c95a commit 095794f
Copy full SHA for 095794f

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
@@ -856,6 +856,8 @@ added:
856	856	- v10.16.0
857	857	-->
858	858
	859	+ * Extends: [`ZlibBase`][]
	860	+
859	861	Compress data using the Brotli algorithm.
860	862
861	863	## Class: `zlib.BrotliDecompress`
@@ -866,6 +868,8 @@ added:
866	868	- v10.16.0
867	869	-->
868	870
	871	+ * Extends: [`ZlibBase`][]
	872	+
869	873	Decompress data using the Brotli algorithm.
870	874
871	875	## Class: `zlib.Deflate`
@@ -874,6 +878,8 @@ Decompress data using the Brotli algorithm.
874	878	added: v0.5.8
875	879	-->
876	880
	881	+ * Extends: [`ZlibBase`][]
	882	+
877	883	Compress data using deflate.
878	884
879	885	## Class: `zlib.DeflateRaw`
@@ -882,6 +888,8 @@ Compress data using deflate.
882	888	added: v0.5.8
883	889	-->
884	890
	891	+ * Extends: [`ZlibBase`][]
	892	+
885	893	Compress data using deflate, and do not append a `zlib` header.
886	894
887	895	## Class: `zlib.Gunzip`
@@ -901,6 +909,8 @@ changes:
901	909	description: A truncated input stream will now result in an `'error'` event.
902	910	-->
903	911
	912	+ * Extends: [`ZlibBase`][]
	913	+
904	914	Decompress a gzip stream.
905	915
906	916	## Class: `zlib.Gzip`
@@ -909,6 +919,8 @@ Decompress a gzip stream.
909	919	added: v0.5.8
910	920	-->
911	921
	922	+ * Extends: [`ZlibBase`][]
	923	+
912	924	Compress data using gzip.
913	925
914	926	## Class: `zlib.Inflate`
@@ -921,6 +933,8 @@ changes:
921	933	description: A truncated input stream will now result in an `'error'` event.
922	934	-->
923	935
	936	+ * Extends: [`ZlibBase`][]
	937	+
924	938	Decompress a deflate stream.
925	939
926	940	## Class: `zlib.InflateRaw`
@@ -936,6 +950,8 @@ changes:
936	950	description: A truncated input stream will now result in an `'error'` event.
937	951	-->
938	952
	953	+ * Extends: [`ZlibBase`][]
	954	+
939	955	Decompress a raw deflate stream.
940	956
941	957	## Class: `zlib.Unzip`
@@ -944,6 +960,8 @@ Decompress a raw deflate stream.
944	960	added: v0.5.8
945	961	-->
946	962
	963	+ * Extends: [`ZlibBase`][]
	964	+
947	965	Decompress either a Gzip- or Deflate-compressed stream by auto-detecting
948	966	the header.
949	967
@@ -959,6 +977,8 @@ changes:
959	977	description: This class was renamed from `Zlib` to `ZlibBase`.
960	978	-->
961	979
	980	+ * Extends: [`stream.Transform`][]
	981	+
962	982	Not exported by the `node:zlib` module. It is documented here because it is the
963	983	base class of the compressor/decompressor classes.
964	984
@@ -1707,6 +1727,7 @@ Decompress a chunk of data with [`ZstdDecompress`][].
1707	1727	[`InflateRaw`]: #class-zlibinflateraw
1708	1728	[`Inflate`]: #class-zlibinflate
1709	1729	[`Unzip`]: #class-zlibunzip
	1730	+ [`ZlibBase`]: #class-zlibzlibbase
1710	1731	[`ZstdCompress`]: #class-zlibzstdcompress
1711	1732	[`ZstdDecompress`]: #class-zlibzstddecompress
1712	1733	[`buffer.kMaxLength`]: buffer.md#bufferkmaxlength

0 commit comments

Comments

0 (0)