Chris Barber
715bb7f89f
doc: fixed wording in child_process
Signed-off-by: Fedor Indutny <fedor@indutny.com>
11 years ago
Yazhong Liu
e86c9421ef
doc: document url `slashes` property
Slashes should be documented, because 3rd-party protocols -- those
postfixed with `://` -- would incorrectly `format` and `parse` if they
didn't set/get the `slashes` option.
Signed-off-by: Timothy J Fontaine <tjfontaine@gmail.com>
11 years ago
Calvin Metcalf
31150df92a
doc: clarify `end` vs `finish` in streams
Adds a section to the transform stream docs to clarify the
difference between the `end` event and the `finish` events.
Also clarifies the wording on the `end` event.
11 years ago
Forrest L Norvell
793c76e5c6
docs: add cautionary note to emitter.removeAllListeners
Signed-off-by: Fedor Indutny <fedor@indutny.com>
11 years ago
Julian Gruber
0ee99565f9
doc: fix missing link in net api
Signed-off-by: Fedor Indutny <fedor@indutny.com>
11 years ago
Julian Gruber
b0fa931e07
doc: fix order in net api
Signed-off-by: Fedor Indutny <fedor@indutny.com>
11 years ago
William Bert
bfb7de5e75
docs: fix links to streams
Signed-off-by: Fedor Indutny <fedor@indutny.com>
11 years ago
Brian White
c2d32f4c0e
doc: add missing space
Signed-off-by: Fedor Indutny <fedor@indutny.com>
11 years ago
Dominic Tarr
cdc093b31f
docs: correct tls docs. server -> client
when a pfx file is passed to tls.connection,
it is the client private key, not the server's private key.
11 years ago
Goh Yisheng (Andrew)
47bed4828c
doc: typo clean up in tls
11 years ago
Shuhei Kagawa
43a29f53ca
doc: remove an unused arg in process.stdin.
The argument of process.stdin's readable event handler is not used.
11 years ago
Nicolas Talle
1efe6837b2
doc: update assert.markdown
Update assert.throws() and assert.doesNotThrow() docs
11 years ago
Anton Khlynovskiy
1fa5cff4f2
docs: clarify process.stdin and old mode
12 years ago
Pedro Ballesteros
1d734a75b5
doc: stdout blocking or non-blocking behaviour
Makes clear that the behaviour of stdout is blocking
in Linux/Unix even when they refer to pipes.
11 years ago
Raynos
abbde2fafa
doc: mention objectMode for Writable streams
12 years ago
Christian
b222374b07
doc: changed timer id to object
fix #7074
11 years ago
Brian White
3595139b51
doc: fix diffieHellman.getGenerator() description
11 years ago
Benjamin Waters
d2147c55c2
doc: fix references to error keyword
References for err.signal and err.code should be error.signal and
error.code.
Fixes joyent/node#6862
11 years ago
Maxime Quandalle
154d9d2163
doc: add an example about multiple extensions
`path.extname` returns only the last extension
11 years ago
Wyatt Preul
8c05570258
docs: clarify origin in agent.maxSockets section
12 years ago
Fedor Indutny
0ec3770767
doc: readline document TTY utils
fix #6933
11 years ago
Scott González
9975ff603b
doc: fix typo in readline
11 years ago
Sam Roberts
abe02553f2
doc: clarify Windows signal sending emulation
11 years ago
Sam Roberts
198ed0bd0d
doc: describe child_process.fork() silent option
11 years ago
Sam Roberts
549be1caa8
doc: child_process.execFile arguments are optional
11 years ago
Sam Roberts
7bd6e33318
doc: streams must be open to be passed to child
spawn stdio options can be a 'stream', but the following code
fails with "Incorrect value for stdio stream: [object Object]",
despite being a stream. The problem is the test isn't really
for a stream, its for an object with a numeric `.fd` property,
and streams do not have an fd until their async 'open' event
has occurred. This is reasonable, but was not documented.
child_process.spawn('date', [], {stdio: [
'ignore',
fs.createWriteStream('out.txt',{flags:'a'}),
'ignore']})
11 years ago
gluxon
56913d2cde
doc: Fix argument typo in SimpleProtocol example
11 years ago
Lorenz Leutgeb
fc7e217a30
doc: fix typo in cluster page
11 years ago
Maciej Małecki
5a8de857f0
doc: document that `process.send` is synchronous
Ref #2598
11 years ago
Timothy J Fontaine
ffb718b5a3
doc: clarify process on exit safe usage
11 years ago
Ron Korving
3917232030
docs: process.on('exit') receives exit code
The fact that the "exit" event passes the exit code as an argument
as omitted from the documentation. This adds the explanation and
augments the example code to show that.
11 years ago
Dav Glass
34b9280da4
doc: Fix missing backtick in debugger doc
12 years ago
Mathias Bynens
f89a7185b7
doc: mention `binary` as deafult for Hash strings
11 years ago
Gabriel Farrell
04d52270b6
doc: "finish" event is on the writable stream
11 years ago
Yazhong Liu
5cfee927cd
doc: mention execArgv in setupMaster
11 years ago
Fedor Indutny
796834bf18
doc: document 'error' event for stream.Writable
fix #5255
11 years ago
Yazhong Liu
bd7fa92de4
doc: list execArgv option for child_process.fork()
11 years ago
Gabriel Falkenberg
94c4ba9dd3
doc: change constant to consistent
11 years ago
Sam Roberts
8aac118b69
process: document kill(0), disallow kill(O_RDWR)
The null signal test existed, but only tested the case where the target
process existed, not when it did not exist.
Also clarified that SIGUSR1 is reserved by Node.js only for receiveing,
its not at all reserved when sending a signal with kill().
kill(pid, 'O_RDWR'), or any other node constant, "worked". I fixed this
by also checking for 'SIG'. The same as done in the isSignal() function.
Now the signal names supported by process.kill() are the same as those
supported by process.on().
12 years ago
Yazhong Liu
fcfaa392ae
doc: net: fix typo in example code
11 years ago
Michael Ridgway
a32b8787a4
doc: http: document ServerResponse 'finish' event
11 years ago
Nikolai Vavilov
207a3e10f8
doc: http: properly document callback argument
11 years ago
Linus Unnebäck
953d7184ec
doc: clarify child_process error behaviour
Clarify that an 'error' event may or may not be followed by an 'exit'
event and that it's not safe to make assumptions either way.
11 years ago
Fedor Indutny
88dc1fcb62
crypto: `randomBytes` is non-blocking
Add NOTE section in documentation, mentioning that `randomBytes` won't
block when entropy sources are drained.
fix #6372
12 years ago
Fedor Indutny
5885f464f0
net: fix `new net.Socket` documentation
`Socket` no longer accepts `type` option, and also accepts `readable`,
`writable` options.
fix #6541
11 years ago
Fedor Indutny
0be5a94c56
doc: encoding is ignored if input is a Buffer
NOTE: it wasn't in 0.8
fixes #6386
12 years ago
Sam Roberts
155df9ca76
doc: document node signal handling
Partly lifted from uv.h, partly from observation of node.cc.
11 years ago
Ben Noordhuis
0c5981b226
doc: dgram: reword dgram.Socket#send() docs
Make it clear that the address argument is not really optional and fix
some Engrish and long lines while we're here.
Fixes #6433 .
11 years ago
Phillip Alexander
977c54adb5
doc: fs: clarify fs.symlink Windows specific args
11 years ago
Ryan Graham
5ac6f4de13
doc: improve module documentation
Expands on when to use module.exports vs. exports. This is a recurring
question on mailing list and continues to confuse new devs.
11 years ago