summaryrefslogtreecommitdiff
path: root/doc/api/zlib.md
diff options
context:
space:
mode:
authorTobias Nießen <tniessen@tnie.de>2017-06-06 11:00:32 +0200
committerTobias Nießen <tniessen@tnie.de>2017-06-14 00:18:59 +0200
commite318c8a97a4adc2503d9c16a9af9f34df0e42d1b (patch)
tree5e3732d8c87d6be923e29f06265c8edeee54ed33 /doc/api/zlib.md
parent80c9ef0b6be57d42632526818a3b0c3f20f225a1 (diff)
downloadandroid-node-v8-e318c8a97a4adc2503d9c16a9af9f34df0e42d1b.tar.gz
android-node-v8-e318c8a97a4adc2503d9c16a9af9f34df0e42d1b.tar.bz2
android-node-v8-e318c8a97a4adc2503d9c16a9af9f34df0e42d1b.zip
doc: fix minor issues reported in #9538
oath.md: make order of properties consistent tls.md: remove spaces in getPeerCertificate signature tls.md: add deprecation notice to server.connections http.md: fix signature of request.end crypto.md: change crypto parameters to camelCase vm.md: add missing apostrophe vm.md: fix signature of vm.runInNewContext zlib.md: improve description of zlib.createXYZ PR-URL: https://github.com/nodejs/node/pull/13491 Ref: https://github.com/nodejs/node/issues/9538 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/zlib.md')
-rw-r--r--doc/api/zlib.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/zlib.md b/doc/api/zlib.md
index 0995a51e7f..8b5653a72c 100644
--- a/doc/api/zlib.md
+++ b/doc/api/zlib.md
@@ -440,14 +440,14 @@ Provides an object enumerating Zlib-related constants.
added: v0.5.8
-->
-Returns a new [Deflate][] object with an [options][].
+Creates and returns a new [Deflate][] object with the given [options][].
## zlib.createDeflateRaw([options])
<!-- YAML
added: v0.5.8
-->
-Returns a new [DeflateRaw][] object with an [options][].
+Creates and returns a new [DeflateRaw][] object with the given [options][].
*Note*: The zlib library rejects requests for 256-byte windows (i.e.,
`{ windowBits: 8 }` in `options`). An `Error` will be thrown when creating
@@ -458,35 +458,35 @@ a [DeflateRaw][] object with this specific value of the `windowBits` option.
added: v0.5.8
-->
-Returns a new [Gunzip][] object with an [options][].
+Creates and returns a new [Gunzip][] object with the given [options][].
## zlib.createGzip([options])
<!-- YAML
added: v0.5.8
-->
-Returns a new [Gzip][] object with an [options][].
+Creates and returns a new [Gzip][] object with the given [options][].
## zlib.createInflate([options])
<!-- YAML
added: v0.5.8
-->
-Returns a new [Inflate][] object with an [options][].
+Creates and returns a new [Inflate][] object with the given [options][].
## zlib.createInflateRaw([options])
<!-- YAML
added: v0.5.8
-->
-Returns a new [InflateRaw][] object with an [options][].
+Creates and returns a new [InflateRaw][] object with the given [options][].
## zlib.createUnzip([options])
<!-- YAML
added: v0.5.8
-->
-Returns a new [Unzip][] object with an [options][].
+Creates and returns a new [Unzip][] object with the given [options][].
## Convenience Methods