Skip to content

Commit a3ca7f3

Browse files
anonrigtargos
authored andcommitted
zlib: make all zstd functions experimental
PR-URL: #56964 Refs: #52100 Reviewed-By: Jan Krems <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Chemi Atlow <[email protected]>
1 parent 40cdf75 commit a3ca7f3

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

doc/api/zlib.md

+28
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,8 @@ See [below][Brotli parameters] for more details on Brotli-specific options.
496496

497497
### For Zstd-based streams
498498

499+
> Stability: 1 - Experimental
500+
499501
There are equivalents to the zlib options for Zstd-based streams, although
500502
these options have different ranges than the zlib ones:
501503

@@ -720,6 +722,8 @@ These advanced options are available for controlling decompression:
720722

721723
### Zstd constants
722724

725+
> Stability: 1 - Experimental
726+
723727
<!-- YAML
724728
added: REPLACEME
725729
-->
@@ -729,6 +733,8 @@ streams:
729733

730734
#### Flush operations
731735

736+
> Stability: 1 - Experimental
737+
732738
The following values are valid flush operations for Zstd-based streams:
733739

734740
* `zlib.constants.ZSTD_e_continue` (default for all operations)
@@ -737,6 +743,8 @@ The following values are valid flush operations for Zstd-based streams:
737743

738744
#### Compressor options
739745

746+
> Stability: 1 - Experimental
747+
740748
There are several options that can be set on Zstd encoders, affecting
741749
compression efficiency and speed. Both the keys and the values can be accessed
742750
as properties of the `zlib.constants` object.
@@ -749,12 +757,16 @@ The most important options are:
749757

750758
#### Pledged Source Size
751759

760+
> Stability: 1 - Experimental
761+
752762
It's possible to specify the expected total size of the uncompressed input via
753763
`opts.pledgedSrcSize`. If the size doesn't match at the end of the input,
754764
compression will fail with the code `ZSTD_error_srcSize_wrong`.
755765

756766
#### Decompressor options
757767

768+
> Stability: 1 - Experimental
769+
758770
These advanced options are available for controlling decompression:
759771

760772
* `ZSTD_d_windowLogMax`
@@ -1025,6 +1037,8 @@ the inflate and deflate algorithms.
10251037

10261038
## Class: `ZstdOptions`
10271039

1040+
> Stability: 1 - Experimental
1041+
10281042
<!-- YAML
10291043
added: REPLACEME
10301044
-->
@@ -1054,6 +1068,8 @@ const stream = zlib.createZstdCompress({
10541068

10551069
## Class: `zlib.ZstdCompress`
10561070

1071+
> Stability: 1 - Experimental
1072+
10571073
<!-- YAML
10581074
added: REPLACEME
10591075
-->
@@ -1062,6 +1078,8 @@ Compress data using the Zstd algorithm.
10621078

10631079
## Class: `zlib.ZstdDecompress`
10641080

1081+
> Stability: 1 - Experimental
1082+
10651083
<!-- YAML
10661084
added: REPLACEME
10671085
-->
@@ -1243,6 +1261,8 @@ Creates and returns a new [`Unzip`][] object.
12431261

12441262
## `zlib.createZstdCompress([options])`
12451263

1264+
> Stability: 1 - Experimental
1265+
12461266
<!-- YAML
12471267
added: REPLACEME
12481268
-->
@@ -1253,6 +1273,8 @@ Creates and returns a new [`ZstdCompress`][] object.
12531273

12541274
## `zlib.createZstdDecompress([options])`
12551275

1276+
> Stability: 1 - Experimental
1277+
12561278
<!-- YAML
12571279
added: REPLACEME
12581280
-->
@@ -1609,6 +1631,8 @@ Decompress a chunk of data with [`Unzip`][].
16091631

16101632
### `zlib.zstdCompress(buffer[, options], callback)`
16111633

1634+
> Stability: 1 - Experimental
1635+
16121636
<!-- YAML
16131637
added: REPLACEME
16141638
-->
@@ -1619,6 +1643,8 @@ added: REPLACEME
16191643

16201644
### `zlib.zstdCompressSync(buffer[, options])`
16211645

1646+
> Stability: 1 - Experimental
1647+
16221648
<!-- YAML
16231649
added: REPLACEME
16241650
-->
@@ -1640,6 +1666,8 @@ added: REPLACEME
16401666

16411667
### `zlib.zstdDecompressSync(buffer[, options])`
16421668

1669+
> Stability: 1 - Experimental
1670+
16431671
<!-- YAML
16441672
added: REPLACEME
16451673
-->

0 commit comments

Comments
 (0)