Skip to content
Closed
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
doc: fill in missing zstd docs
Signed-off-by: James M Snell <jasnell@gmail.com>
  • Loading branch information
jasnell committed Sep 11, 2026
commit 0db765649f87fb6285e11aece024a564ecd8a632
8 changes: 7 additions & 1 deletion doc/api/zlib.md
Original file line number Diff line number Diff line change
Expand Up @@ -2158,7 +2158,8 @@ added: v0.5.8
-->

* `kind` **Default:** `zlib.constants.Z_FULL_FLUSH` for zlib-based streams,
`zlib.constants.BROTLI_OPERATION_FLUSH` for Brotli-based streams.
`zlib.constants.BROTLI_OPERATION_FLUSH` for Brotli-based streams, and
`zlib.constants.ZSTD_e_flush` for Zstd-based streams.
* `callback` {Function}

Flush pending data. Don't call this frivolously, premature flushes negatively
Expand Down Expand Up @@ -2229,6 +2230,9 @@ Each Zstd-based class takes an `options` object. All options are optional.
* `finishFlush` {integer} **Default:** `zlib.constants.ZSTD_e_end`
* `chunkSize` {integer} **Default:** `16 * 1024`
* `params` {Object} Key-value object containing indexed [Zstd parameters][].
* `pledgedSrcSize` {number} Expected total size of the uncompressed input. It
must be a non-negative safe integer and must match the input size when
compression finishes. Only applicable to Zstd compressors.
* `maxOutputLength` {integer} Limits output size when using
[convenience methods][]. **Default:** [`buffer.kMaxLength`][]
* `info` {boolean} If `true`, returns an object with `buffer` and `engine`. **Default:** `false`
Expand Down Expand Up @@ -3069,6 +3073,8 @@ Compress a chunk of data with [`ZstdCompress`][].

### `zlib.zstdDecompress(buffer[, options], callback)`

> Stability: 1 - Experimental

<!-- YAML
added:
- v23.8.0
Expand Down