Commit a3ca7f3
zlib: make all zstd functions experimental
PR-URL: #56964
Refs: #52100
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>1 parent 40cdf75 commit a3ca7f3
1 file changed
Lines changed: 28 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -496,6 +496,8 @@ See [below][Brotli parameters] for more details on Brotli-specific options. | |||
| 496 | 496 | ||
| 497 | 497 | ### For Zstd-based streams | |
| 498 | 498 | ||
| 499 | + > Stability: 1 - Experimental | ||
| 500 | + | ||
| 499 | 501 | There are equivalents to the zlib options for Zstd-based streams, although | |
| 500 | 502 | these options have different ranges than the zlib ones: | |
| 501 | 503 | ||
@@ -720,6 +722,8 @@ These advanced options are available for controlling decompression: | |||
| 720 | 722 | ||
| 721 | 723 | ### Zstd constants | |
| 722 | 724 | ||
| 725 | + > Stability: 1 - Experimental | ||
| 726 | + | ||
| 723 | 727 | <!-- YAML | |
| 724 | 728 | added: REPLACEME | |
| 725 | 729 | --> | |
@@ -729,6 +733,8 @@ streams: | |||
| 729 | 733 | ||
| 730 | 734 | #### Flush operations | |
| 731 | 735 | ||
| 736 | + > Stability: 1 - Experimental | ||
| 737 | + | ||
| 732 | 738 | The following values are valid flush operations for Zstd-based streams: | |
| 733 | 739 | ||
| 734 | 740 | * `zlib.constants.ZSTD_e_continue` (default for all operations) | |
@@ -737,6 +743,8 @@ The following values are valid flush operations for Zstd-based streams: | |||
| 737 | 743 | ||
| 738 | 744 | #### Compressor options | |
| 739 | 745 | ||
| 746 | + > Stability: 1 - Experimental | ||
| 747 | + | ||
| 740 | 748 | There are several options that can be set on Zstd encoders, affecting | |
| 741 | 749 | compression efficiency and speed. Both the keys and the values can be accessed | |
| 742 | 750 | as properties of the `zlib.constants` object. | |
@@ -749,12 +757,16 @@ The most important options are: | |||
| 749 | 757 | ||
| 750 | 758 | #### Pledged Source Size | |
| 751 | 759 | ||
| 760 | + > Stability: 1 - Experimental | ||
| 761 | + | ||
| 752 | 762 | It's possible to specify the expected total size of the uncompressed input via | |
| 753 | 763 | `opts.pledgedSrcSize`. If the size doesn't match at the end of the input, | |
| 754 | 764 | compression will fail with the code `ZSTD_error_srcSize_wrong`. | |
| 755 | 765 | ||
| 756 | 766 | #### Decompressor options | |
| 757 | 767 | ||
| 768 | + > Stability: 1 - Experimental | ||
| 769 | + | ||
| 758 | 770 | These advanced options are available for controlling decompression: | |
| 759 | 771 | ||
| 760 | 772 | * `ZSTD_d_windowLogMax` | |
@@ -1025,6 +1037,8 @@ the inflate and deflate algorithms. | |||
| 1025 | 1037 | ||
| 1026 | 1038 | ## Class: `ZstdOptions` | |
| 1027 | 1039 | ||
| 1040 | + > Stability: 1 - Experimental | ||
| 1041 | + | ||
| 1028 | 1042 | <!-- YAML | |
| 1029 | 1043 | added: REPLACEME | |
| 1030 | 1044 | --> | |
@@ -1054,6 +1068,8 @@ const stream = zlib.createZstdCompress({ | |||
| 1054 | 1068 | ||
| 1055 | 1069 | ## Class: `zlib.ZstdCompress` | |
| 1056 | 1070 | ||
| 1071 | + > Stability: 1 - Experimental | ||
| 1072 | + | ||
| 1057 | 1073 | <!-- YAML | |
| 1058 | 1074 | added: REPLACEME | |
| 1059 | 1075 | --> | |
@@ -1062,6 +1078,8 @@ Compress data using the Zstd algorithm. | |||
| 1062 | 1078 | ||
| 1063 | 1079 | ## Class: `zlib.ZstdDecompress` | |
| 1064 | 1080 | ||
| 1081 | + > Stability: 1 - Experimental | ||
| 1082 | + | ||
| 1065 | 1083 | <!-- YAML | |
| 1066 | 1084 | added: REPLACEME | |
| 1067 | 1085 | --> | |
@@ -1243,6 +1261,8 @@ Creates and returns a new [`Unzip`][] object. | |||
| 1243 | 1261 | ||
| 1244 | 1262 | ## `zlib.createZstdCompress([options])` | |
| 1245 | 1263 | ||
| 1264 | + > Stability: 1 - Experimental | ||
| 1265 | + | ||
| 1246 | 1266 | <!-- YAML | |
| 1247 | 1267 | added: REPLACEME | |
| 1248 | 1268 | --> | |
@@ -1253,6 +1273,8 @@ Creates and returns a new [`ZstdCompress`][] object. | |||
| 1253 | 1273 | ||
| 1254 | 1274 | ## `zlib.createZstdDecompress([options])` | |
| 1255 | 1275 | ||
| 1276 | + > Stability: 1 - Experimental | ||
| 1277 | + | ||
| 1256 | 1278 | <!-- YAML | |
| 1257 | 1279 | added: REPLACEME | |
| 1258 | 1280 | --> | |
@@ -1609,6 +1631,8 @@ Decompress a chunk of data with [`Unzip`][]. | |||
| 1609 | 1631 | ||
| 1610 | 1632 | ### `zlib.zstdCompress(buffer[, options], callback)` | |
| 1611 | 1633 | ||
| 1634 | + > Stability: 1 - Experimental | ||
| 1635 | + | ||
| 1612 | 1636 | <!-- YAML | |
| 1613 | 1637 | added: REPLACEME | |
| 1614 | 1638 | --> | |
@@ -1619,6 +1643,8 @@ added: REPLACEME | |||
| 1619 | 1643 | ||
| 1620 | 1644 | ### `zlib.zstdCompressSync(buffer[, options])` | |
| 1621 | 1645 | ||
| 1646 | + > Stability: 1 - Experimental | ||
| 1647 | + | ||
| 1622 | 1648 | <!-- YAML | |
| 1623 | 1649 | added: REPLACEME | |
| 1624 | 1650 | --> | |
@@ -1640,6 +1666,8 @@ added: REPLACEME | |||
| 1640 | 1666 | ||
| 1641 | 1667 | ### `zlib.zstdDecompressSync(buffer[, options])` | |
| 1642 | 1668 | ||
| 1669 | + > Stability: 1 - Experimental | ||
| 1670 | + | ||
| 1643 | 1671 | <!-- YAML | |
| 1644 | 1672 | added: REPLACEME | |
| 1645 | 1673 | --> | |
0 commit comments