Skip to content

Commit 6f56f84

Browse files
committed
fixup! zlib: expose rejectGarbageAfterEnd option
1 parent a47d32d commit 6f56f84

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

‎doc/api/zlib.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -840,8 +840,9 @@ ignored by the decompression classes.
840840
* `maxOutputLength` {integer} Limits output size when using
841841
[convenience methods][]. **Default:** [`buffer.kMaxLength`][]
842842
* `rejectGarbageAfterEnd` {boolean} If `true`, decompression fails when
843-
trailing input is detected after the end of the compressed stream.
844-
**Default:** `false`
843+
trailing input is detected after the end of the compressed stream. This
844+
includes unreadable bytes and, when decompressing gzip, additional gzip
845+
members following the first member. **Default:** `false`
845846

846847
See the [`deflateInit2` and `inflateInit2`][] documentation for more
847848
information.
@@ -873,8 +874,7 @@ Each Brotli-based class takes an `options` object. All options are optional.
873874
[convenience methods][]. **Default:** [`buffer.kMaxLength`][]
874875
* `info` {boolean} If `true`, returns an object with `buffer` and `engine`. **Default:** `false`
875876
* `rejectGarbageAfterEnd` {boolean} If `true`, decompression fails when
876-
trailing input is detected after the end of the compressed stream.
877-
**Default:** `false`
877+
input remains after the first complete compressed stream. **Default:** `false`
878878

879879
For example:
880880

@@ -1119,8 +1119,7 @@ Each Zstd-based class takes an `options` object. All options are optional.
11191119
improve compression efficiency when compressing or decompressing data that
11201120
shares common patterns with the dictionary.
11211121
* `rejectGarbageAfterEnd` {boolean} If `true`, decompression fails when
1122-
trailing input is detected after the end of the compressed stream.
1123-
**Default:** `false`
1122+
input remains after the first complete compressed stream. **Default:** `false`
11241123

11251124
For example:
11261125

0 commit comments

Comments
 (0)