Skip to content

doc: add links to parent class for node:zlib classes #58433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 25, 2025
Merged

doc: add links to parent class for node:zlib classes #58433

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions doc/api/zlib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -856,6 +856,8 @@ added:
- v10.16.0
-->

* Extends: [`ZlibBase`][]

Compress data using the Brotli algorithm.

## Class: `zlib.BrotliDecompress`
Expand All @@ -866,6 +868,8 @@ added:
- v10.16.0
-->

* Extends: [`ZlibBase`][]

Decompress data using the Brotli algorithm.

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

* Extends: [`ZlibBase`][]

Compress data using deflate.

## Class: `zlib.DeflateRaw`
Expand All @@ -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`
Expand All @@ -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`
Expand All @@ -909,6 +919,8 @@ Decompress a gzip stream.
added: v0.5.8
-->

* Extends: [`ZlibBase`][]

Compress data using gzip.

## Class: `zlib.Inflate`
Expand All @@ -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`
Expand All @@ -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`
Expand All @@ -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.

Expand All @@ -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.

Expand Down Expand Up @@ -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
Expand Down
Loading