Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
0b0cd8d
test: correct header length subtraction
Trott Nov 29, 2019
4e93f23
doc: update socket.bufferSize text
Trott Nov 30, 2019
827c53b
doc: update README.md to fix active/maint times
mhdawson Nov 28, 2019
50a54ce
doc: update signature algorithm in release doc
MylesBorins Nov 26, 2019
043163a
doc: revise REPL uncaught exception text
Trott Nov 30, 2019
2aa8654
test: fix test-benchmark-streams
Trott Dec 2, 2019
6c6ffdd
test: use arrow functions in async-hooks tests
GaryGSC Oct 26, 2019
6a35c38
doc: fix typographical error
Trott Nov 30, 2019
3b096c2
build,win: propagate error codes in vcbuild
joaocgreis Nov 30, 2019
197b616
test: add an indicator `isIBMi`
dmabupt Nov 29, 2019
f3c3b1d
test: add coverage for ERR_TLS_INVALID_PROTOCOL_VERSION
Trott Nov 30, 2019
a83ccf8
test: skip test-domain-error-types in debug mode temporariliy
Trott Nov 24, 2019
0054636
doc: allow <code> in header elements
Trott Dec 23, 2019
424266a
doc,dns: use code markup/markdown in headers
Trott Dec 23, 2019
ef4ecf4
doc: use code markup/markdown in headers in addons documentation
Trott Dec 23, 2019
a933028
doc,assert: use code markup/markdown in headers
Trott Dec 23, 2019
a2bea80
doc,async_hooks: use code markup/markdown in headers
Trott Dec 23, 2019
b4934ef
doc,buffer: use code markup/markdown in headers
Trott Dec 23, 2019
3e07682
doc,child_process: use code markup/markdown in headers
Trott Dec 23, 2019
700e28d
doc,cluster: use code markup/markdown in headers
Trott Dec 24, 2019
d92200a
doc,console: use code markup/markdown in headers
Trott Dec 24, 2019
af66dba
doc,crypto: use code markup/markdown in headers
Trott Dec 24, 2019
e00e4d2
doc: use code markup/markdown in headers in deprecations documentation
Trott Dec 24, 2019
17efccd
doc,dgram: use code markup/markdown in headers
Trott Dec 24, 2019
4eb5e60
doc,domain: use code markup/markdown in headers
Trott Dec 24, 2019
e74fa1e
doc,errors: use code markup/markdown in headers
Trott Dec 24, 2019
c763c70
doc,esm: use code markup/markdown in headers
Trott Dec 24, 2019
b1f2dd6
doc,events: use code markup/markdown in headers
Trott Dec 24, 2019
e91846c
doc,fs: use code markup/markdown in headers
Trott Dec 24, 2019
23f5045
doc: use code markup/markdown in headers in globals documentation
Trott Dec 24, 2019
3e95c86
doc,http: use code markup/markdown in headers
Trott Dec 24, 2019
f6084bc
doc,http2: use code markup/markdown in headers
Trott Dec 24, 2019
eb82113
doc,https: use code markup/markdown in headers
Trott Dec 24, 2019
3ac8493
doc,inspector: use code markup/markdown in headers
Trott Dec 24, 2019
e2a4293
doc,module: use code markup/markdown in headers
Trott Dec 24, 2019
7cce4bb
doc,net: use code markup/markdown in headers
Trott Dec 24, 2019
cc65a3c
doc,os: use code markup/markdown in headers
Trott Dec 24, 2019
7b73674
doc,path: use code markup/markdown in headers
Trott Dec 24, 2019
6885967
doc,perf_hooks: use code markup/markdown in headers
Trott Dec 24, 2019
a8f3310
doc,process: use code markup/markdown in headers
Trott Dec 24, 2019
0c253b9
doc,punycode: use code markup/markdown in headers
Trott Dec 24, 2019
003e188
doc,querystring: use code markup/markdown in headers
Trott Dec 24, 2019
b4b4da4
doc,readline: use code markup/markdown in headers
Trott Dec 24, 2019
728c984
doc,repl: use code markup/markdown in headers
Trott Dec 24, 2019
3a1772c
doc,stream: use code markup/markdown in headers
Trott Dec 24, 2019
13e067b
doc,string_decoder: use code markup/markdown in headers
Trott Dec 24, 2019
e3f26c4
doc,timers: use code markup/markdown in headers
Trott Dec 24, 2019
5a76e25
doc,tls: use code markup/markdown in headers
Trott Dec 24, 2019
3c2c8fa
doc,tty: use code markup/markdown in headers
Trott Dec 24, 2019
a0717c7
doc,url: use code markup/markdown in headers
Trott Dec 24, 2019
1bf0dd7
doc,zlib: use code markup/markdown in headers
Trott Dec 24, 2019
f7a70bb
doc,util: use code markup/markdown in headers
Trott Dec 24, 2019
de8f03a
doc,v8: use code markup/markdown in headers
Trott Dec 24, 2019
58132d5
doc,worker: use code markup/markdown in headers
Trott Dec 24, 2019
113cbef
doc,vm: use code markup/markdown in headers
Trott Dec 25, 2019
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,child_process: use code markup/markdown in headers
PR-URL: #31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
  • Loading branch information
Trott committed Dec 27, 2019
commit 3e076826029fce690af7ef6544f8dd2c26663ff3
56 changes: 28 additions & 28 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ exec('"my script.cmd" a b', (err, stdout, stderr) => {
});
```

### child_process.exec(command\[, options\]\[, callback\])
### `child_process.exec(command[, options][, callback])`
<!-- YAML
added: v0.1.90
changes:
Expand Down Expand Up @@ -233,7 +233,7 @@ async function lsExample() {
lsExample();
```

### child_process.execFile(file\[, args\]\[, options\]\[, callback\])
### `child_process.execFile(file[, args][, options][, callback])`
<!-- YAML
added: v0.1.91
changes:
Expand Down Expand Up @@ -317,7 +317,7 @@ getVersion();
function. Any input containing shell metacharacters may be used to trigger
arbitrary command execution.**

### child_process.fork(modulePath\[, args\]\[, options\])
### `child_process.fork(modulePath[, args][, options])`
<!-- YAML
added: v0.5.0
changes:
Expand Down Expand Up @@ -382,7 +382,7 @@ current process.
The `shell` option available in [`child_process.spawn()`][] is not supported by
`child_process.fork()` and will be ignored if set.

### child_process.spawn(command\[, args\]\[, options\])
### `child_process.spawn(command[, args][, options])`
<!-- YAML
added: v0.1.90
changes:
Expand Down Expand Up @@ -523,7 +523,7 @@ Node.js currently overwrites `argv[0]` with `process.execPath` on startup, so
parameter passed to `spawn` from the parent, retrieve it with the
`process.argv0` property instead.

#### options.detached
#### `options.detached`
<!-- YAML
added: v0.7.10
-->
Expand Down Expand Up @@ -581,7 +581,7 @@ const subprocess = spawn('prg', [], {
subprocess.unref();
```

#### options.stdio
#### `options.stdio`
<!-- YAML
added: v0.7.10
changes:
Expand Down Expand Up @@ -686,7 +686,7 @@ Blocking calls like these are mostly useful for simplifying general-purpose
scripting tasks and for simplifying the loading/processing of application
configuration at startup.

### child_process.execFileSync(file\[, args\]\[, options\])
### `child_process.execFileSync(file[, args][, options])`
<!-- YAML
added: v0.11.12
changes:
Expand Down Expand Up @@ -753,7 +753,7 @@ If the process times out or has a non-zero exit code, this method will throw an
function. Any input containing shell metacharacters may be used to trigger
arbitrary command execution.**

### child_process.execSync(command\[, options\])
### `child_process.execSync(command[, options])`
<!-- YAML
added: v0.11.12
changes:
Expand Down Expand Up @@ -813,7 +813,7 @@ The [`Error`][] object will contain the entire result from
**Never pass unsanitized user input to this function. Any input containing shell
metacharacters may be used to trigger arbitrary command execution.**

### child_process.spawnSync(command\[, args\]\[, options\])
### `child_process.spawnSync(command[, args][, options])`
<!-- YAML
added: v0.11.12
changes:
Expand Down Expand Up @@ -890,7 +890,7 @@ exited.
function. Any input containing shell metacharacters may be used to trigger
arbitrary command execution.**

## Class: ChildProcess
## Class: `ChildProcess`
<!-- YAML
added: v2.2.0
-->
Expand All @@ -904,7 +904,7 @@ use the [`child_process.spawn()`][], [`child_process.exec()`][],
[`child_process.execFile()`][], or [`child_process.fork()`][] methods to create
instances of `ChildProcess`.

### Event: 'close'
### Event: `'close'`
<!-- YAML
added: v0.7.7
-->
Expand Down Expand Up @@ -933,7 +933,7 @@ ls.on('exit', (code) => {
});
```

### Event: 'disconnect'
### Event: `'disconnect'`
<!-- YAML
added: v0.7.2
-->
Expand All @@ -944,7 +944,7 @@ The `'disconnect'` event is emitted after calling the
possible to send or receive messages, and the [`subprocess.connected`][]
property is `false`.

### Event: 'error'
### Event: `'error'`

* `err` {Error} The error.

Expand All @@ -960,7 +960,7 @@ against accidentally invoking handler functions multiple times.

See also [`subprocess.kill()`][] and [`subprocess.send()`][].

### Event: 'exit'
### Event: `'exit'`
<!-- YAML
added: v0.1.90
-->
Expand All @@ -983,7 +983,7 @@ re-raise the handled signal.

See waitpid(2).

### Event: 'message'
### Event: `'message'`
<!-- YAML
added: v0.5.9
-->
Expand All @@ -998,7 +998,7 @@ The `'message'` event is triggered when a child process uses
The message goes through serialization and parsing. The resulting
message might not be the same as what is originally sent.

### subprocess.channel
### `subprocess.channel`
<!-- YAML
added: v7.1.0
-->
Expand All @@ -1008,7 +1008,7 @@ added: v7.1.0
The `subprocess.channel` property is a reference to the child's IPC channel. If
no IPC channel currently exists, this property is `undefined`.

### subprocess.connected
### `subprocess.connected`
<!-- YAML
added: v0.7.2
-->
Expand All @@ -1019,7 +1019,7 @@ The `subprocess.connected` property indicates whether it is still possible to
send and receive messages from a child process. When `subprocess.connected` is
`false`, it is no longer possible to send or receive messages.

### subprocess.disconnect()
### `subprocess.disconnect()`
<!-- YAML
added: v0.7.2
-->
Expand All @@ -1038,7 +1038,7 @@ When the child process is a Node.js instance (e.g. spawned using
[`child_process.fork()`][]), the `process.disconnect()` method can be invoked
within the child process to close the IPC channel as well.

### subprocess.kill(\[signal\])
### `subprocess.kill([signal])`
<!-- YAML
added: v0.1.90
-->
Expand Down Expand Up @@ -1100,7 +1100,7 @@ setTimeout(() => {
}, 2000);
```

### subprocess.killed
### `subprocess.killed`
<!-- YAML
added: v0.5.10
-->
Expand All @@ -1112,7 +1112,7 @@ The `subprocess.killed` property indicates whether the child process
successfully received a signal from `subprocess.kill()`. The `killed` property
does not indicate that the child process has been terminated.

### subprocess.pid
### `subprocess.pid`
<!-- YAML
added: v0.1.90
-->
Expand All @@ -1129,7 +1129,7 @@ console.log(`Spawned child pid: ${grep.pid}`);
grep.stdin.end();
```

### subprocess.ref()
### `subprocess.ref()`
<!-- YAML
added: v0.7.10
-->
Expand All @@ -1150,7 +1150,7 @@ subprocess.unref();
subprocess.ref();
```

### subprocess.send(message\[, sendHandle\[, options\]\]\[, callback\])
### `subprocess.send(message[, sendHandle[, options]][, callback])`
<!-- YAML
added: v0.5.9
changes:
Expand Down Expand Up @@ -1331,7 +1331,7 @@ It is also recommended that any `'message'` handlers in the child process
verify that `socket` exists, as the connection may have been closed during the
time it takes to send the connection to the child.

### subprocess.stderr
### `subprocess.stderr`
<!-- YAML
added: v0.1.90
-->
Expand All @@ -1346,7 +1346,7 @@ then this will be `null`.
`subprocess.stderr` is an alias for `subprocess.stdio[2]`. Both properties will
refer to the same value.

### subprocess.stdin
### `subprocess.stdin`
<!-- YAML
added: v0.1.90
-->
Expand All @@ -1364,7 +1364,7 @@ then this will be `null`.
`subprocess.stdin` is an alias for `subprocess.stdio[0]`. Both properties will
refer to the same value.

### subprocess.stdio
### `subprocess.stdio`
<!-- YAML
added: v0.7.10
-->
Expand Down Expand Up @@ -1404,7 +1404,7 @@ assert.strictEqual(subprocess.stdio[2], null);
assert.strictEqual(subprocess.stdio[2], subprocess.stderr);
```

### subprocess.stdout
### `subprocess.stdout`
<!-- YAML
added: v0.1.90
-->
Expand All @@ -1429,7 +1429,7 @@ subprocess.stdout.on('data', (data) => {
});
```

### subprocess.unref()
### `subprocess.unref()`
<!-- YAML
added: v0.7.10
-->
Expand Down