Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
114 commits
Select commit Hold shift + click to select a range
1576484
stream: fix no data on partial decode
mscdex Feb 14, 2016
e93a4f3
doc: fix links in Addons docs
estliberitas Feb 4, 2016
3e14933
doc: clarify code of conduct reporting
juliepagano Feb 5, 2016
91997ba
http,util: fix typos in comments
estliberitas Feb 17, 2016
ea7daed
doc: add "building node with ninja" guide
Fishrock123 Jan 19, 2016
0a69a17
doc: add Сковорода Никита Андреевич to the CTC
rvagg Feb 17, 2016
822ccdc
doc: add Ali Ijaz Sheikh to the CTC
rvagg Feb 17, 2016
94d7d0a
doc: add Rich Trott to the CTC
rvagg Feb 17, 2016
fb8db9e
doc: add Evan Lucas to the CTC
rvagg Feb 17, 2016
55f59e8
doc: document fs.datasync(Sync)
Feb 24, 2016
ed6db20
doc: update V8 URL
strawbrary Mar 2, 2016
788aa45
win,build: support Visual C++ Build Tools 2015
joaocgreis Mar 9, 2016
fae367b
lib: freelist: use .pop() for allocation
subzey Jan 26, 2016
cbb9633
doc: add onboarding resources
Fishrock123 Nov 9, 2015
8c465cd
doc: add info to docs on how to submit docs patch
Sequoia Jan 8, 2016
58a3984
build: add option to select VS version
greenjava Jan 12, 2016
d7dcd9a
src: return UV_EAI_NODATA on empty lookup
cjihrig Jan 15, 2016
3efe113
stream: prevent object map change in ReadableState
evanlucas Jan 19, 2016
7337e35
test: move cluster tests to parallel
Trott Jan 20, 2016
fd268fd
doc: clarify when writable.write callback is called
kevinoid Jan 22, 2016
659ef2d
buffer: remove duplicated code in fromObject
entertainyou Jan 29, 2016
12eae07
test: remove unneeded bind() and related comments
aayn Feb 1, 2016
61cecc1
stream: prevent object map change in TransformState
evanlucas Feb 2, 2016
04d6d5b
string_decoder: fix performance regression
mscdex Feb 11, 2016
6a21708
repl: handle quotes within regexp literal
princejwesley Feb 6, 2016
d5debfb
doc: add note for binary safe string reading
Feb 9, 2016
115a980
doc: update removeListener behaviour
vaibhav93 Feb 12, 2016
47e8c5c
build: skip msi build if WiX is not found
dimhotepus Feb 13, 2016
aaacf7f
http: remove unnecessary check
mscdex Feb 15, 2016
20b2dfe
http: remove old, confusing comment
mscdex Feb 15, 2016
5107f0a
doc: document base64url encoding support
tristanls Feb 15, 2016
fd95d5d
doc: fix buf.readInt16LE output
chinedufn Feb 17, 2016
d900716
doc: improve unhandledException doc copy
jasnell Feb 17, 2016
2b7a88c
deps: cherry-pick 2e4da65 from v8's 4.8 upstream
mhdawson Feb 17, 2016
9a1c8ba
doc: improve httpVersionMajor / httpVersionMajor
JacksonTian Feb 18, 2016
0605d41
doc: add missing property in cluster example
MrOutput Feb 18, 2016
3006485
doc: fix typo in pbkdf2Sync code sample
mjcuva Feb 18, 2016
b3e3569
debugger: remove unneeded callback check
Trott Feb 19, 2016
bf960bf
tools: add Node.js-specific ESLint rules
Trott Feb 19, 2016
6eb3fb9
test: refactor test-dgram-udp4
santigimeno Feb 20, 2016
48d069d
test: remove flaky designation from fixed tests
Trott Feb 26, 2016
8899016
test: mitigate flaky test-http-agent
Trott Feb 21, 2016
a1747c9
test: prevent flakey test on pi2
trevnorris Mar 2, 2016
213e13e
test: increase timeouts on some unref timers tests
Fishrock123 Feb 21, 2016
34776a1
tools: enable additional lint rules
Trott Feb 22, 2016
a80e9a6
doc: fix relative links in net docs
evanlucas Feb 22, 2016
82f49e3
doc: fix links in tls, cluster docs
estliberitas Feb 19, 2016
5642615
tools: apply custom buffer lint rule to /lib only
Trott Feb 22, 2016
ad3c726
test: fix test-timers.reliability on OS X
Trott Feb 23, 2016
2ca3373
url: group slashed protocols by protocol name
nettofarah Feb 23, 2016
2539ade
crypto: PBKDF2 works with `int` not `ssize_t`
indutny Feb 23, 2016
f0b3f41
test: fix flaky child-process-fork-regr-gh-2847
santigimeno Feb 24, 2016
a50ef9d
benchmark: add benchmark for buf.compare()
Trott Feb 26, 2016
7c0fc04
test: retry on known SmartOS bug
Trott Feb 26, 2016
9af26f0
doc: fix crypto function indentation level
mscdex Feb 26, 2016
5355e4a
doc: add Testing WG
Trott Feb 26, 2016
52a0992
test: increase timeout for test-tls-fast-writing
Trott Feb 28, 2016
ba7a247
test: apply Linux workaround to Linux only
Trott Feb 28, 2016
46b1043
doc: update NAN urls in ROADMAP.md and doc/releases.md
ronkorving Feb 28, 2016
ff1774b
doc: fix typo in child_process documentation
evanlucas Feb 28, 2016
ee98a3e
doc: add clarification on birthtime in fs stat
kthelgason Feb 28, 2016
5974a6d
tools: enable no-extra-parens in ESLint
Trott Mar 1, 2016
144f574
build: remove --quiet from eslint invocation
Mar 2, 2016
9cbd062
build: update Node.js logo on Win installer
eljefedelrodeodeljefe Mar 2, 2016
62ff109
test: remove broken debugger scenarios
Trott Mar 2, 2016
db6d14c
test: check memoryUsage properties The properties on memoryUsage were…
geek Mar 3, 2016
ed05eeb
doc: update link green to match homepage
silverwind Mar 3, 2016
1f5f341
tools: enable no-self-assign ESLint rule
Trott Mar 3, 2016
e987929
build: correctly detect clang version
Mar 3, 2016
81d00f3
doc: document directories in test directory
mike182uk Mar 3, 2016
d9703fa
doc: fix typo in fs.symlink
targos Mar 4, 2016
63c836f
tools: reduce verbosity of cpplint
thefourtheye Mar 6, 2016
49602af
doc: fix dns.resolveCname description typo
axvm Mar 9, 2016
2474e0d
docs: update link to iojs+release ci job
Mar 9, 2016
3c1d762
doc: move build instructions to a new document
jbergstroem Mar 9, 2016
16378e3
doc: fix markdown links
stevemao Mar 10, 2016
80bae47
doc: include typo in 'unhandledRejection' example
r1b Mar 11, 2016
49fbf57
doc: add mattloring to collaborators
Mar 11, 2016
1d02091
doc: add phillipj to collaborators
phillipj Mar 11, 2016
db21c17
doc: add benjamingr to collaborator list
benjamingr Mar 11, 2016
9b80b25
doc: add whitlockjc to collaborators
whitlockjc Mar 11, 2016
dbbb185
doc: add AndreasMadsen to collaborators
AndreasMadsen Mar 11, 2016
5ab4dfb
doc: add thekemkid to collaborators
GlenTiki Mar 11, 2016
3a94d78
doc: add fansworld-claudio to collaborators
claudiorodriguez Mar 11, 2016
d8eeca4
doc: remove non-standard use of hyphens
svozza Mar 12, 2016
dd79419
doc: fix typo in api/addons
watilde Mar 13, 2016
3d5f57b
doc: clarify type of first argument in zlib
fanatid Mar 13, 2016
cf02135
doc: explain path.format() algorithm
Trott Mar 13, 2016
a60b0c2
tls: fix assert in context._external accessor
bnoordhuis Mar 2, 2016
7b7fb6b
docs: fix man pages link if tok type is code
mithun-daa Mar 15, 2016
fa3ed70
doc: Add note about use of JSON.stringify()
mithun-daa Mar 15, 2016
2c82efb
doc: fix return value of write methods
fb55 Mar 16, 2016
6d631af
build: update Node.js logo on OSX installer
rvagg Feb 24, 2016
7167733
doc: update fansworld-claudio username on README
claudiorodriguez Mar 13, 2016
a47f209
collaborator_guide: clarify commit message rules
geek Mar 11, 2016
9a6494e
doc: fix typo in child_process docs
benjamingr Mar 13, 2016
ee1365f
doc: update release tweet template
Fishrock123 Mar 9, 2016
d015c54
doc: fix invalid path doc comments
Trott Mar 11, 2016
a411bf9
benchmark: fix lint errors
Trott Mar 2, 2016
9c8d596
tools,benchmark: increase lint compliance
Trott Feb 25, 2016
17a6e0d
benchmark: refactor to eliminate redeclared vars
Trott Feb 28, 2016
c0e0815
benchmark: use strict mode
Trott Feb 20, 2016
95e1048
benchmark: fix linting issues
Trott Mar 17, 2016
a15c6e1
tools: enable linting for benchmarks
Trott Mar 17, 2016
cda345e
tools: support testing known issues
cjihrig Mar 2, 2016
3e32397
test: bug repro for vm function redefinition
cjihrig Mar 2, 2016
2b7fd50
tools: update gyp to b3cef02
Oct 19, 2015
f9c32e2
tools: fix gyp to work on MacOSX without XCode
Feb 10, 2015
8c682a3
test: eval a strict function
kthelgason Feb 15, 2016
67e30b2
doc: topic blocking vs non-blocking
jrit Feb 19, 2016
4c089a6
build: don't install github templates
jbergstroem Mar 9, 2016
d8a5a31
deps: update openssl config
Mar 6, 2016
825db16
doc: fix typo in synchronous randomBytes example
WebReflection Mar 18, 2016
1ab7853
fs: Remove unused branches
benjamingr Mar 22, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
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>
  • Loading branch information
fanatid authored and Myles Borins committed Mar 21, 2016
commit 3d5f57b6f4d71f9320ef522b603545551ab49387
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