From 3d5f57b6f4d71f9320ef522b603545551ab49387 Mon Sep 17 00:00:00 2001 From: Kirill Fomichev Date: Sun, 13 Mar 2016 19:16:15 +0300 Subject: [PATCH] doc: clarify type of first argument in zlib The current documentation for Convenience Methods specifies that the first argument can be either `string or buffer`, `string` or `raw Buffer`. This commit replaces all these instances with `Buffer or string`. PR-URL: https://github.com/nodejs/node/pull/5685 Reviewed-By: Claudio Rodriguez Reviewed-By: James M Snell --- doc/api/zlib.markdown | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/doc/api/zlib.markdown b/doc/api/zlib.markdown index 60cd7145abbbfb..da20024ca2109f 100644 --- a/doc/api/zlib.markdown +++ b/doc/api/zlib.markdown @@ -324,7 +324,7 @@ Returns a new [Unzip][] object with an [options][]. -All of these take a string or buffer as the first argument, an optional second +All of these take a [Buffer][] or string as the first argument, an optional second argument to supply options to the zlib classes and will call the supplied callback with `callback(error, result)`. @@ -332,45 +332,39 @@ Every method has a `*Sync` counterpart, which accept the same arguments, but without a callback. ### zlib.deflate(buf[, options], callback) +### zlib.deflateSync(buf[, options]) -Compress a string with Deflate. +Compress a Buffer or string with Deflate. ### zlib.deflateRaw(buf[, options], callback) ### zlib.deflateRawSync(buf[, options]) -Compress a string with DeflateRaw. - -### zlib.deflateSync(buf[, options]) - -Compress a string with Deflate. +Compress a Buffer or string with DeflateRaw. ### zlib.gunzip(buf[, options], callback) ### zlib.gunzipSync(buf[, options]) -Decompress a raw Buffer with Gunzip. +Decompress a Buffer or string with Gunzip. ### zlib.gzip(buf[, options], callback) ### zlib.gzipSync(buf[, options]) -Compress a string with Gzip. +Compress a Buffer or string with Gzip. ### zlib.inflate(buf[, options], callback) +### zlib.inflateSync(buf[, options]) -Decompress a raw Buffer with Inflate. +Decompress a Buffer or string with Inflate. ### zlib.inflateRaw(buf[, options], callback) ### zlib.inflateRawSync(buf[, options]) -Decompress a raw Buffer with InflateRaw. - -### zlib.inflateSync(buf[, options]) - -Decompress a raw Buffer with Inflate. +Decompress a Buffer or string with InflateRaw. ### zlib.unzip(buf[, options], callback) ### zlib.unzipSync(buf[, options]) -Decompress a raw Buffer with Unzip. +Decompress a Buffer or string with Unzip. [accept-encoding]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3 [content-encoding]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 @@ -384,3 +378,4 @@ Decompress a raw Buffer with Unzip. [Inflate]: #zlib_class_zlib_inflate [InflateRaw]: #zlib_class_zlib_inflateraw [Unzip]: #zlib_class_zlib_unzip +[Buffer]: buffer.html