Commit 62926d8
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: #5685
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 29510aa commit 62926d8
1 file changed
Lines changed: 11 additions & 16 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -324,53 +324,47 @@ Returns a new [Unzip][] object with an [options][]. | |||
| 324 | 324 | ||
| 325 | 325 | <!--type=misc--> | |
| 326 | 326 | ||
| 327 | - All of these take a string or buffer as the first argument, an optional second | ||
| 327 | + All of these take a [Buffer][] or string as the first argument, an optional second | ||
| 328 | 328 | argument to supply options to the zlib classes and will call the supplied | |
| 329 | 329 | callback with `callback(error, result)`. | |
| 330 | 330 | ||
| 331 | 331 | Every method has a `*Sync` counterpart, which accept the same arguments, but | |
| 332 | 332 | without a callback. | |
| 333 | 333 | ||
| 334 | 334 | ### zlib.deflate(buf[, options], callback) | |
| 335 | + ### zlib.deflateSync(buf[, options]) | ||
| 335 | 336 | ||
| 336 | - Compress a string with Deflate. | ||
| 337 | + Compress a Buffer or string with Deflate. | ||
| 337 | 338 | ||
| 338 | 339 | ### zlib.deflateRaw(buf[, options], callback) | |
| 339 | 340 | ### zlib.deflateRawSync(buf[, options]) | |
| 340 | 341 | ||
| 341 | - Compress a string with DeflateRaw. | ||
| 342 | - | ||
| 343 | - ### zlib.deflateSync(buf[, options]) | ||
| 344 | - | ||
| 345 | - Compress a string with Deflate. | ||
| 342 | + Compress a Buffer or string with DeflateRaw. | ||
| 346 | 343 | ||
| 347 | 344 | ### zlib.gunzip(buf[, options], callback) | |
| 348 | 345 | ### zlib.gunzipSync(buf[, options]) | |
| 349 | 346 | ||
| 350 | - Decompress a raw Buffer with Gunzip. | ||
| 347 | + Decompress a Buffer or string with Gunzip. | ||
| 351 | 348 | ||
| 352 | 349 | ### zlib.gzip(buf[, options], callback) | |
| 353 | 350 | ### zlib.gzipSync(buf[, options]) | |
| 354 | 351 | ||
| 355 | - Compress a string with Gzip. | ||
| 352 | + Compress a Buffer or string with Gzip. | ||
| 356 | 353 | ||
| 357 | 354 | ### zlib.inflate(buf[, options], callback) | |
| 355 | + ### zlib.inflateSync(buf[, options]) | ||
| 358 | 356 | ||
| 359 | - Decompress a raw Buffer with Inflate. | ||
| 357 | + Decompress a Buffer or string with Inflate. | ||
| 360 | 358 | ||
| 361 | 359 | ### zlib.inflateRaw(buf[, options], callback) | |
| 362 | 360 | ### zlib.inflateRawSync(buf[, options]) | |
| 363 | 361 | ||
| 364 | - Decompress a raw Buffer with InflateRaw. | ||
| 365 | - | ||
| 366 | - ### zlib.inflateSync(buf[, options]) | ||
| 367 | - | ||
| 368 | - Decompress a raw Buffer with Inflate. | ||
| 362 | + Decompress a Buffer or string with InflateRaw. | ||
| 369 | 363 | ||
| 370 | 364 | ### zlib.unzip(buf[, options], callback) | |
| 371 | 365 | ### zlib.unzipSync(buf[, options]) | |
| 372 | 366 | ||
| 373 | - Decompress a raw Buffer with Unzip. | ||
| 367 | + Decompress a Buffer or string with Unzip. | ||
| 374 | 368 | ||
| 375 | 369 | [accept-encoding]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3 | |
| 376 | 370 | [content-encoding]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 | |
@@ -384,3 +378,4 @@ Decompress a raw Buffer with Unzip. | |||
| 384 | 378 | [Inflate]: #zlib_class_zlib_inflate | |
| 385 | 379 | [InflateRaw]: #zlib_class_zlib_inflateraw | |
| 386 | 380 | [Unzip]: #zlib_class_zlib_unzip | |
| 381 | + [Buffer]: buffer.html | ||
0 commit comments