diff --git a/doc/api/zlib.md b/doc/api/zlib.md index 8e5f14621b9dd1..6947b2047eae02 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -373,6 +373,10 @@ added: v0.5.8 Returns a new [DeflateRaw][] object with an [options][]. +*Note*: The zlib library rejects requests for 256-byte windows (i.e., +`{ windowBits: 8 }` in `options`). An `Error` will be thrown when creating a +[DeflateRaw][] object with this specific value of the `windowBits` option. + ## zlib.createGunzip([options])