1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add example for zlib.createGzip()

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/28136
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Masashi Hirano <shisama07@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Alex Ramirez 2019-06-08 08:16:21 -05:00 committed by Rich Trott
parent d1bb21fc2c
commit 57ed7c33b1
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api/zlib.md
View File

@ -20,7 +20,14 @@ const fs = require('fs');
const inp = fs.createReadStream('input.txt');
const out = fs.createWriteStream('input.txt.gz');
inp.pipe(gzip).pipe(out);
inp.pipe(gzip)
.on('error', () => {
// handle error
})
.pipe(out)
.on('error', () => {
// handle error
});
```
It is also possible to compress or decompress data in a single step:
@ -679,6 +686,7 @@ added: v0.5.8
* `options` {zlib options}
Creates and returns a new [`Gzip`][] object.
See [example][zlib.createGzip example].
## zlib.createInflate([options])
<!-- YAML
@ -1046,3 +1054,4 @@ Decompress a chunk of data with [`Unzip`][].
[RFC 7932]: https://www.rfc-editor.org/rfc/rfc7932.txt
[pool size]: cli.html#cli_uv_threadpool_size_size
[zlib documentation]: https://zlib.net/manual.html#Constants
[zlib.createGzip example]: #zlib_zlib