Chris Barber
715bb7f89f
doc: fixed wording in child_process
...
Signed-off-by: Fedor Indutny <fedor@indutny.com >
2014-05-31 10:09:02 +01:00
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 >
2014-05-22 09:27:03 -07:00
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.
2014-05-21 16:48:46 -07:00
Forrest L Norvell
793c76e5c6
docs: add cautionary note to emitter.removeAllListeners
...
Signed-off-by: Fedor Indutny <fedor@indutny.com >
2014-04-29 14:15:10 +04:00
Julian Gruber
0ee99565f9
doc: fix missing link in net api
...
Signed-off-by: Fedor Indutny <fedor@indutny.com >
2014-04-24 19:59:41 +04:00
Julian Gruber
b0fa931e07
doc: fix order in net api
...
Signed-off-by: Fedor Indutny <fedor@indutny.com >
2014-04-24 19:59:41 +04:00
William Bert
bfb7de5e75
docs: fix links to streams
...
Signed-off-by: Fedor Indutny <fedor@indutny.com >
2014-04-11 00:52:33 +04:00
Brian White
c2d32f4c0e
doc: add missing space
...
Signed-off-by: Fedor Indutny <fedor@indutny.com >
2014-04-07 17:45:04 +04:00
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.
2014-04-02 15:34:16 +04:00
Goh Yisheng (Andrew)
47bed4828c
doc: typo clean up in tls
2014-03-31 07:40:17 -07:00
Shuhei Kagawa
43a29f53ca
doc: remove an unused arg in process.stdin.
...
The argument of process.stdin's readable event handler is not used.
2014-03-10 15:30:40 -07:00
Nicolas Talle
1efe6837b2
doc: update assert.markdown
...
Update assert.throws() and assert.doesNotThrow() docs
2014-02-23 18:09:26 +04:00
Anton Khlynovskiy
1fa5cff4f2
docs: clarify process.stdin and old mode
2014-02-18 13:52:14 -08:00
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.
2014-02-18 13:36:00 -08:00
Raynos
abbde2fafa
doc: mention objectMode for Writable streams
2014-02-18 10:29:04 -08:00
Christian
b222374b07
doc: changed timer id to object
...
fix #7074
2014-02-13 02:18:10 +04:00
Brian White
3595139b51
doc: fix diffieHellman.getGenerator() description
2014-02-09 02:42:41 +04:00
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
2014-02-04 12:50:24 +04:00
Maxime Quandalle
154d9d2163
doc: add an example about multiple extensions
...
`path.extname` returns only the last extension
2014-02-03 12:38:40 +04:00
Wyatt Preul
8c05570258
docs: clarify origin in agent.maxSockets section
2014-01-29 03:39:54 +04:00
Fedor Indutny
0ec3770767
doc: readline document TTY utils
...
fix #6933
2014-01-25 12:10:44 -08:00
Scott González
9975ff603b
doc: fix typo in readline
2014-01-24 18:56:46 +04:00
Sam Roberts
abe02553f2
doc: clarify Windows signal sending emulation
2014-01-16 08:41:04 -08:00
Sam Roberts
198ed0bd0d
doc: describe child_process.fork() silent option
2014-01-16 07:35:12 -08:00
Sam Roberts
549be1caa8
doc: child_process.execFile arguments are optional
2014-01-16 07:35:12 -08:00
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']})
2014-01-13 21:36:56 +00:00
gluxon
56913d2cde
doc: Fix argument typo in SimpleProtocol example
2014-01-10 08:42:34 -08:00
Lorenz Leutgeb
fc7e217a30
doc: fix typo in cluster page
2014-01-08 23:39:02 +04:00
Maciej Małecki
5a8de857f0
doc: document that process.send is synchronous
...
Ref #2598
2013-12-31 14:52:43 -08:00
Timothy J Fontaine
ffb718b5a3
doc: clarify process on exit safe usage
2013-12-31 14:48:20 -08:00
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.
2013-12-31 14:38:09 -08:00
Dav Glass
34b9280da4
doc: Fix missing backtick in debugger doc
2013-12-30 11:44:13 -08:00
Mathias Bynens
f89a7185b7
doc: mention binary as deafult for Hash strings
2013-12-11 20:39:22 -08:00
Gabriel Farrell
04d52270b6
doc: "finish" event is on the writable stream
2013-12-11 20:29:17 -08:00
Yazhong Liu
5cfee927cd
doc: mention execArgv in setupMaster
2013-12-06 10:45:40 -08:00
Fedor Indutny
796834bf18
doc: document 'error' event for stream.Writable
...
fix #5255
2013-12-06 10:26:49 -08:00
Yazhong Liu
bd7fa92de4
doc: list execArgv option for child_process.fork()
2013-12-02 13:41:30 -08:00
Gabriel Falkenberg
94c4ba9dd3
doc: change constant to consistent
2013-12-02 13:31:23 -08:00
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().
2013-12-02 10:41:37 -08:00
Yazhong Liu
fcfaa392ae
doc: net: fix typo in example code
2013-11-30 14:05:45 +01:00
Michael Ridgway
a32b8787a4
doc: http: document ServerResponse 'finish' event
2013-11-28 22:35:25 +01:00
Nikolai Vavilov
207a3e10f8
doc: http: properly document callback argument
2013-11-28 22:31:11 +01:00
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.
2013-11-23 15:46:50 +01:00
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
2013-11-19 13:15:50 +04:00
Fedor Indutny
5885f464f0
net: fix new net.Socket documentation
...
`Socket` no longer accepts `type` option, and also accepts `readable`,
`writable` options.
fix #6541
2013-11-19 12:50:16 +04:00
Fedor Indutny
0be5a94c56
doc: encoding is ignored if input is a Buffer
...
NOTE: it wasn't in 0.8
fixes #6386
2013-11-07 11:02:19 -08:00
Sam Roberts
155df9ca76
doc: document node signal handling
...
Partly lifted from uv.h, partly from observation of node.cc.
2013-10-31 21:19:04 +01:00
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 .
2013-10-29 10:32:15 +01:00
Phillip Alexander
977c54adb5
doc: fs: clarify fs.symlink Windows specific args
2013-10-27 21:02:19 +01:00
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.
2013-10-27 11:47:11 +01:00