Skip to content

Commit

Permalink
doc: clarify type of first argument in zlib
Browse files Browse the repository at this point in the history
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: #5685
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
fanatid authored and rvagg committed Mar 16, 2016
1 parent 29510aa commit 62926d8
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions doc/api/zlib.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -324,53 +324,47 @@ Returns a new [Unzip][] object with an [options][].

<!--type=misc-->

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)`.

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
Expand All @@ -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

0 comments on commit 62926d8

Please sign in to comment.