Skip to content

zlib: Make the finish flush flag configurable #6069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
addaleax wants to merge 2 commits into from
Closed

zlib: Make the finish flush flag configurable #6069

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35ca9ad
zlib: Make the finish flush flag configurable
addaleax Apr 5, 2016
f85f54c
doc: Add full example for `finishFlush` to zlib docs
addaleax Apr 7, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
doc: Add full example for finishFlush to zlib docs
  • Loading branch information
@addaleax
addaleax committed Apr 7, 2016
commit f85f54c2116f353c74e4f4c402b88f2aa5b6cf8e
25 changes: 25 additions & 0 deletions doc/api/zlib.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,31 @@ http.createServer((request, response) => {
}).listen(1337);
```

By default, the zlib methods with throw an error when decompressing
truncated data. However, if it is known that the data is incomplete, or
the desire is to inspect only the beginning of a compressed file, it is
possible to suppress the default error handling by changing the flushing
method that is used to compressed the last chunk of input data:

```js
// This is a truncated version of the buffer from the above examples
const buffer = new Buffer('eJzT0yMA', 'base64');

zlib.unzip(buffer, { finishFlush: zlib.Z_SYNC_FLUSH }, (err, buffer) => {
if (!err) {
console.log(buffer.toString());
} else {
// handle error
}
});
```

This will not change the behavior in other error-throwing situations, e.g.
when the input data has an invalid format. Using this method, it will not be
possible to determine whether the input ended prematurely or lacks the
integrity checks, making it necessary to manually check that the
decompressed result is valid.

## Memory Usage Tuning

<!--type=misc-->
Expand Down