Skip to content

Commit

Permalink
Added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
danielgindi committed Jul 10, 2020
1 parent 88bb202 commit d4a01cb
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ The following compression codings are supported:

- deflate
- gzip
- br (brotli)

**Note** Brotli provides better and faster compression then gzip or deflate, but is supported only since Node.js versions v11.7.0 and v10.16.0.

## Install

Expand Down Expand Up @@ -46,6 +49,9 @@ as compressing will transform the body.
those listed below, [zlib](http://nodejs.org/api/zlib.html) options may be
passed in to the options object.

As for *brotli*, a default is set to compression level 4, unless
[anything else is specified](https://nodejs.org/api/zlib.html#zlib_class_brotlioptions).

##### chunkSize

The default value is `zlib.Z_DEFAULT_CHUNK`, or `16384`.
Expand Down

0 comments on commit d4a01cb

Please sign in to comment.