Skip to content

Commit 82fe365

Browse files
anonrigaduh95
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 fbe9301 commit 82fe365

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`
@@ -1041,6 +1053,8 @@ the inflate and deflate algorithms.
10411053

10421054
## Class: `ZstdOptions`
10431055

1056+
> Stability: 1 - Experimental
1057+
10441058
<!-- YAML
10451059
added: REPLACEME
10461060
-->
@@ -1070,6 +1084,8 @@ const stream = zlib.createZstdCompress({
10701084

10711085
## Class: `zlib.ZstdCompress`
10721086

1087+
> Stability: 1 - Experimental
1088+
10731089
<!-- YAML
10741090
added: REPLACEME
10751091
-->
@@ -1078,6 +1094,8 @@ Compress data using the Zstd algorithm.
10781094

10791095
## Class: `zlib.ZstdDecompress`
10801096

1097+
> Stability: 1 - Experimental
1098+
10811099
<!-- YAML
10821100
added: REPLACEME
10831101
-->
@@ -1257,6 +1275,8 @@ Creates and returns a new [`Unzip`][] object.
12571275

12581276
## `zlib.createZstdCompress([options])`
12591277

1278+
> Stability: 1 - Experimental
1279+
12601280
<!-- YAML
12611281
added: REPLACEME
12621282
-->
@@ -1267,6 +1287,8 @@ Creates and returns a new [`ZstdCompress`][] object.
12671287

12681288
## `zlib.createZstdDecompress([options])`
12691289

1290+
> Stability: 1 - Experimental
1291+
12701292
<!-- YAML
12711293
added: REPLACEME
12721294
-->
@@ -1623,6 +1645,8 @@ Decompress a chunk of data with [`Unzip`][].
16231645

16241646
### `zlib.zstdCompress(buffer[, options], callback)`
16251647

1648+
> Stability: 1 - Experimental
1649+
16261650
<!-- YAML
16271651
added: REPLACEME
16281652
-->
@@ -1633,6 +1657,8 @@ added: REPLACEME
16331657

16341658
### `zlib.zstdCompressSync(buffer[, options])`
16351659

1660+
> Stability: 1 - Experimental
1661+
16361662
<!-- YAML
16371663
added: REPLACEME
16381664
-->
@@ -1654,6 +1680,8 @@ added: REPLACEME
16541680

16551681
### `zlib.zstdDecompressSync(buffer[, options])`
16561682

1683+
> Stability: 1 - Experimental
1684+
16571685
<!-- YAML
16581686
added: REPLACEME
16591687
-->

0 commit comments

Comments
 (0)