diff options
| author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-02 04:44:32 +0300 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-04 12:30:36 +0300 |
| commit | 237cbe10fb82ba6ec69b14193a4a970e184306e7 (patch) | |
| tree | 8fbbac215e1f9afcac524404e766c4157d8da145 /doc/api/zlib.md | |
| parent | f7049a20068dc8a7e904b7cdd3d5b307b595dd3a (diff) | |
doc,tools: formalize, unify, codify default values
PR-URL: https://github.com/nodejs/node/pull/19737
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/zlib.md')
| -rw-r--r-- | doc/api/zlib.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/zlib.md b/doc/api/zlib.md index 41b7ed49870..cf9cb34a357 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -303,9 +303,9 @@ Each class takes an `options` object. All options are optional. Note that some options are only relevant when compressing, and are ignored by the decompression classes. -* `flush` {integer} (default: `zlib.constants.Z_NO_FLUSH`) -* `finishFlush` {integer} (default: `zlib.constants.Z_FINISH`) -* `chunkSize` {integer} (default: 16\*1024) +* `flush` {integer} **Default:** `zlib.constants.Z_NO_FLUSH` +* `finishFlush` {integer} **Default:** `zlib.constants.Z_FINISH` +* `chunkSize` {integer} **Default:** `16 * 1024` * `windowBits` {integer} * `level` {integer} (compression only) * `memLevel` {integer} (compression only) @@ -420,7 +420,7 @@ Close the underlying handle. added: v0.5.8 --> -`kind` defaults to `zlib.constants.Z_FULL_FLUSH`. +* `kind` **Default:** `zlib.constants.Z_FULL_FLUSH` Flush pending data. Don't call this frivolously, premature flushes negatively impact the effectiveness of the compression algorithm. |