Skip to content

Commit b88cc7f

Browse files
isaacsisaacs
committed
'make doc' passing. Still needs more cleanup
1 parent 20ba857 commit b88cc7f

26 files changed

+567
-465
lines changed

‎doc/api/child_processes.markdown

Lines changed: 60 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ The ChildProcess class is not intended to be used directly. Use the
2424

2525
### Event: 'exit'
2626

27-
* `code` Number, the exit code, if it exited normally.
28-
* `signal` String, the signal passed to kill the child process, if it
27+
* `code` {Number} the exit code, if it exited normally.
28+
* `signal` {String} the signal passed to kill the child process, if it
2929
was killed by the parent.
3030

3131
This event is emitted after the child process ends. If the process terminated
@@ -44,7 +44,7 @@ An alternative way to check if you can send messages is to see if the
4444

4545
### child.stdin
4646

47-
* Stream object
47+
* {Stream object}
4848

4949
A `Writable Stream` that represents the child process's `stdin`.
5050
Closing this stream via `end()` often causes the child process to terminate.
@@ -54,7 +54,7 @@ not be set.
5454

5555
### child.stdout
5656

57-
* Stream object
57+
* {Stream object}
5858

5959
A `Readable Stream` that represents the child process's `stdout`.
6060

@@ -63,7 +63,7 @@ not be set.
6363

6464
### child.stderr
6565

66-
* Stream object
66+
* {Stream object}
6767

6868
A `Readable Stream` that represents the child process's `stderr`.
6969

@@ -72,7 +72,7 @@ not be set.
7272

7373
### child.pid
7474

75-
* Integer
75+
* {Integer}
7676

7777
The PID of the child process.
7878

@@ -86,7 +86,7 @@ Example:
8686

8787
### child.kill([signal])
8888

89-
* `signal` String
89+
* `signal` {String}
9090

9191
Send a signal to the child process. If no argument is given, the process will
9292
be sent `'SIGTERM'`. See `signal(7)` for a list of available signals.
@@ -108,24 +108,24 @@ See `kill(2)`
108108

109109
### child.send(message, [sendHandle])
110110

111-
* `message` Object
112-
* `sendHandle` Handle object, Optional
111+
* `message` {Object}
112+
* `sendHandle` {Handle object}
113113

114114
Send a message (and, optionally, a handle object) to a child process.
115115

116116
See `child_process.fork()` for details.
117117

118118
## child_process.spawn(command, [args], [options])
119119

120-
* `command` String - The command to run
121-
* `args` Array - List of string arguments, Optional
122-
* `options` Object, Optional
123-
* `cwd` String - Current working directory of the child process
124-
* `customFds` - **Deprecated** File descriptors for the child to use
120+
* `command` {String} The command to run
121+
* `args` {Array} List of string arguments
122+
* `options` {Object}
123+
* `cwd` {String} Current working directory of the child process
124+
* `customFds` {Array} **Deprecated** File descriptors for the child to use
125125
for stdio. (See below)
126-
* `env` Object - Environment key-value pairs
127-
* `setsid` Boolean
128-
* Return: ChildProcess object
126+
* `env` {Object} Environment key-value pairs
127+
* `setsid` {Boolean}
128+
* return: {ChildProcess object}
129129

130130
Launches a new process with the given `command`, with command line arguments in `args`.
131131
If omitted, `args` defaults to an empty Array.
@@ -230,18 +230,21 @@ See also: `child_process.exec()` and `child_process.fork()`
230230

231231
## child_process.exec(command, [options], callback)
232232

233-
* `command` String - The command to run, with space-separated arguments
234-
* `options` Object, Optional
235-
* `cwd` String - Current working directory of the child process
236-
* `customFds` - **Deprecated** File descriptors for the child to use
233+
* `command` {String} The command to run, with space-separated arguments
234+
* `options` {Object}
235+
* `cwd` {String} Current working directory of the child process
236+
* `customFds` {Array} **Deprecated** File descriptors for the child to use
237237
for stdio. (See below)
238-
* `env` Object - Environment key-value pairs
239-
* `setsid` Boolean
240-
* `encoding` String, Default: 'utf8'
241-
* `timeout` Number, Default: 0
242-
* `maxBuffer` Number, Default: 200*1024
243-
* `killSignal` String, Default: 'SIGTERM'
244-
* `callback` Function called with the output when process terminates
238+
* `env` {Object} Environment key-value pairs
239+
* `setsid` {Boolean}
240+
* `encoding` {String} (Default: 'utf8')
241+
* `timeout` {Number} (Default: 0)
242+
* `maxBuffer` {Number} (Default: 200*1024)
243+
* `killSignal` {String} (Default: 'SIGTERM')
244+
* `callback` {Function} called with the output when process terminates
245+
* `code` {Integer} Exit code
246+
* `stdout` {Buffer}
247+
* `stderr` {Buffer}
245248
* Return: ChildProcess object
246249

247250
Runs a command in a shell and buffers the output.
@@ -283,37 +286,45 @@ the child process is killed.
283286

284287
## child_process.execFile(file, args, options, callback)
285288

286-
* `command` String - The command to run, with space-separated arguments
287-
* `options` Object, Optional
288-
* `cwd` String - Current working directory of the child process
289-
* `customFds` - **Deprecated** File descriptors for the child to use
289+
* `file` {String} The filename of the program to run
290+
* `args` {Array} List of string arguments
291+
* `options` {Object}
292+
* `cwd` {String} Current working directory of the child process
293+
* `customFds` {Array} **Deprecated** File descriptors for the child to use
290294
for stdio. (See below)
291-
* `env` Object - Environment key-value pairs
292-
* `setsid` Boolean
293-
* `encoding` String, Default: 'utf8'
294-
* `timeout` Number, Default: 0
295-
* `maxBuffer` Number, Default: 200*1024
296-
* `killSignal` String, Default: 'SIGTERM'
297-
* `callback` Function called with the output when process terminates
295+
* `env` {Object} Environment key-value pairs
296+
* `setsid` {Boolean}
297+
* `encoding` {String} (Default: 'utf8')
298+
* `timeout` {Number} (Default: 0)
299+
* `maxBuffer` {Number} (Default: 200*1024)
300+
* `killSignal` {String} (Default: 'SIGTERM')
301+
* `callback` {Function} called with the output when process terminates
302+
* `code` {Integer} Exit code
303+
* `stdout` {Buffer}
304+
* `stderr` {Buffer}
298305
* Return: ChildProcess object
299306

300307
This is similar to `child_process.exec()` except it does not execute a
301308
subshell but rather the specified file directly. This makes it slightly
302309
leaner than `child_process.exec`. It has the same options.
303310

304311

305-
## child_process.fork(modulePath, [arguments], [options])
312+
## child_process.fork(modulePath, [args], [options])
306313

307-
* `command` String - The command to run, with space-separated arguments
308-
* `options` Object, Optional
309-
* `cwd` String - Current working directory of the child process
310-
* `customFds` - **Deprecated** File descriptors for the child to use
314+
* `modulePath` {String} The module to run in the child
315+
* `args` {Array} List of string arguments
316+
* `options` {Object}
317+
* `cwd` {String} Current working directory of the child process
318+
* `customFds` {Array} **Deprecated** File descriptors for the child to use
311319
for stdio. (See below)
312-
* `env` Object - Environment key-value pairs
313-
* `setsid` Boolean
314-
* `silent` Boolean, If true, child doesn't write to parent's stdout
315-
and stderr.
316-
* `callback` Function called with the output when process terminates
320+
* `env` {Object} Environment key-value pairs
321+
* `setsid` {Boolean}
322+
* `encoding` {String} (Default: 'utf8')
323+
* `timeout` {Number} (Default: 0)
324+
* `callback` {Function} called with the output when process terminates
325+
* `code` {Integer} Exit code
326+
* `stdout` {Buffer}
327+
* `stderr` {Buffer}
317328
* Return: ChildProcess object
318329

319330
This is a special case of the `spawn()` functionality for spawning Node

0 commit comments

Comments
 (0)