@@ -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 `
@@ -1041,6 +1053,8 @@ the inflate and deflate algorithms.
1041
1053
1042
1054
## Class: ` ZstdOptions `
1043
1055
1056
+ > Stability: 1 - Experimental
1057
+
1044
1058
<!-- YAML
1045
1059
added: REPLACEME
1046
1060
-->
@@ -1070,6 +1084,8 @@ const stream = zlib.createZstdCompress({
1070
1084
1071
1085
## Class: ` zlib.ZstdCompress `
1072
1086
1087
+ > Stability: 1 - Experimental
1088
+
1073
1089
<!-- YAML
1074
1090
added: REPLACEME
1075
1091
-->
@@ -1078,6 +1094,8 @@ Compress data using the Zstd algorithm.
1078
1094
1079
1095
## Class: ` zlib.ZstdDecompress `
1080
1096
1097
+ > Stability: 1 - Experimental
1098
+
1081
1099
<!-- YAML
1082
1100
added: REPLACEME
1083
1101
-->
@@ -1257,6 +1275,8 @@ Creates and returns a new [`Unzip`][] object.
1257
1275
1258
1276
## ` zlib.createZstdCompress([options]) `
1259
1277
1278
+ > Stability: 1 - Experimental
1279
+
1260
1280
<!-- YAML
1261
1281
added: REPLACEME
1262
1282
-->
@@ -1267,6 +1287,8 @@ Creates and returns a new [`ZstdCompress`][] object.
1267
1287
1268
1288
## ` zlib.createZstdDecompress([options]) `
1269
1289
1290
+ > Stability: 1 - Experimental
1291
+
1270
1292
<!-- YAML
1271
1293
added: REPLACEME
1272
1294
-->
@@ -1623,6 +1645,8 @@ Decompress a chunk of data with [`Unzip`][].
1623
1645
1624
1646
### ` zlib.zstdCompress(buffer[, options], callback) `
1625
1647
1648
+ > Stability: 1 - Experimental
1649
+
1626
1650
<!-- YAML
1627
1651
added: REPLACEME
1628
1652
-->
@@ -1633,6 +1657,8 @@ added: REPLACEME
1633
1657
1634
1658
### ` zlib.zstdCompressSync(buffer[, options]) `
1635
1659
1660
+ > Stability: 1 - Experimental
1661
+
1636
1662
<!-- YAML
1637
1663
added: REPLACEME
1638
1664
-->
@@ -1654,6 +1680,8 @@ added: REPLACEME
1654
1680
1655
1681
### ` zlib.zstdDecompressSync(buffer[, options]) `
1656
1682
1683
+ > Stability: 1 - Experimental
1684
+
1657
1685
<!-- YAML
1658
1686
added: REPLACEME
1659
1687
-->
0 commit comments