Skip to content

Commit dbcaaba

Browse files
committed
docs(js): document node:child_process
- docs(js): add docs for `node:child_process` - chore: various cleanups Relates to elide-dev/elide#1097 Signed-off-by: Sam Gammon <[email protected]>
1 parent 2711edf commit dbcaaba

File tree

2 files changed

+136
-1
lines changed

2 files changed

+136
-1
lines changed

β€ŽWriterside/e.treeβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<toc-element topic="node-assert.md"/>
3131
<toc-element toc-title="Async Hooks" />
3232
<toc-element toc-title="Buffer" />
33-
<toc-element toc-title="Child Process" />
33+
<toc-element topic="node-childprocess.md"/>
3434
<toc-element toc-title="Crypto" />
3535
<toc-element toc-title="DNS" />
3636
<toc-element topic="node-events.md"/>
Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
---
2+
switcher-label: Imports
3+
---
4+
5+
# Child Process
6+
7+
API support and documentation for the `node:child_process` module.
8+
9+
<tldr>
10+
<p>Module: <code>node:child_process</code></p>
11+
<p>Support: <img style="inline" src="https://img.shields.io/badge/-alpha-blue" alt="alpha" /></p>
12+
<p>Docs: <a href="https://nodejs.org/api/child_process.html">Node.js Child Process Docs</a></p>
13+
</tldr>
14+
15+
<code-block lang="javascript" switcher-key="ESM">import proc from "node:child_process"</code-block>
16+
<code-block lang="javascript" switcher-key="CJS">const proc = require("node:child_process")</code-block>
17+
18+
## Modules
19+
20+
| Status | Module | Docs |
21+
|-------------------------|-------------------------------|-------------------------------------------------------------------------------|
22+
| 🟑 Partially supported. | `node:child_process` | [Node.js Child Process](https://nodejs.org/api/child_process.html) |
23+
24+
## `child_process` | Classes
25+
26+
[`ChildProcess`](https://nodejs.org/api/child_process.html#class-childprocess)
27+
: 🟑 Partially supported.
28+
29+
### `ChildProcess` - Events
30+
31+
[`'close'`](https://nodejs.org/api/child_process.html#event-close)
32+
: πŸ”΄ Not implemented.
33+
34+
[`'disconnect'`](https://nodejs.org/api/child_process.html#event-disconnect)
35+
: πŸ”΄ Not implemented.
36+
37+
[`'error'`](https://nodejs.org/api/child_process.html#event-error)
38+
: πŸ”΄ Not implemented.
39+
40+
[`'exit'`](https://nodejs.org/api/child_process.html#event-exit)
41+
: πŸ”΄ Not implemented.
42+
43+
[`'message'`](https://nodejs.org/api/child_process.html#event-message)
44+
: πŸ”΄ Not implemented.
45+
46+
[`'spawn'`](https://nodejs.org/api/child_process.html#event-spawn)
47+
: πŸ”΄ Not implemented.
48+
49+
### `ChildProcess` - Properties
50+
51+
[`channel`](https://nodejs.org/api/child_process.html#subprocesschannel)
52+
: πŸ”΄ Not implemented.
53+
54+
[`connected`](https://nodejs.org/api/child_process.html#subprocessconnected)
55+
: πŸ”΄ Not implemented.
56+
57+
[`exitCode`](https://nodejs.org/api/child_process.html#subprocessexitcode)
58+
: πŸ”΄ Not implemented.
59+
60+
[`killed`](https://nodejs.org/api/child_process.html#subprocesskilled)
61+
: πŸ”΄ Not implemented.
62+
63+
[`pid`](https://nodejs.org/api/child_process.html#subprocesspid)
64+
: πŸ”΄ Not implemented.
65+
66+
[`signalCode`](https://nodejs.org/api/child_process.html#subprocesssignalcode)
67+
: πŸ”΄ Not implemented.
68+
69+
[`spawnargs`](https://nodejs.org/api/child_process.html#subprocessspawnargs)
70+
: πŸ”΄ Not implemented.
71+
72+
[`spawnfile`](https://nodejs.org/api/child_process.html#subprocessspawnfile)
73+
: πŸ”΄ Not implemented.
74+
75+
[`stdin`](https://nodejs.org/api/child_process.html#subprocesssstdin)
76+
: πŸ”΄ Not implemented.
77+
78+
[`stderr`](https://nodejs.org/api/child_process.html#subprocessstderr)
79+
: πŸ”΄ Not implemented.
80+
81+
[`stdio`](https://nodejs.org/api/child_process.html#subprocessstdio)
82+
: πŸ”΄ Not implemented.
83+
84+
[`stdout`](https://nodejs.org/api/child_process.html#subprocessstdout)
85+
: πŸ”΄ Not implemented.
86+
87+
### `ChildProcess` - Methods
88+
89+
[`disconnect()`](https://nodejs.org/api/child_process.html#subprocessdisconnect)
90+
: πŸ”΄ Not implemented.
91+
92+
[`kill([signal])`](https://nodejs.org/api/child_process.html#subprocesskillsignal)
93+
: πŸ”΄ Not implemented.
94+
95+
[`[Symbol.dispose]()`](https://nodejs.org/api/child_process.html#subprocesssymboldispose)
96+
: πŸ”΄ Not implemented.
97+
98+
[`ref()`](https://nodejs.org/api/child_process.html#subprocessref)
99+
: πŸ”΄ Not implemented.
100+
101+
[`subprocess.send(message[, sendHandle[, options]][, callback])`](https://nodejs.org/api/child_process.html#subprocesssendmessage-sendhandle-options-callback)
102+
: πŸ”΄ Not implemented.
103+
104+
[`unref()`](https://nodejs.org/api/child_process.html#subprocessunref)
105+
: πŸ”΄ Not implemented.
106+
107+
## `child_process` | Methods
108+
109+
API support is available for spawning child processes **synchronously** or **asynchronously**; refer to the
110+
corresponding section below for your desired call style.
111+
112+
### Process Creation (Asynchronous)
113+
114+
[`exec(command[, options][, callback])`](https://nodejs.org/api/child_process.html#child_processexeccommand-options-callback)
115+
: πŸ”΄ Not implemented.
116+
117+
[`execFile(file[, args][, options][, callback])`](https://nodejs.org/api/child_process.html#child_processexecfilefile-args-options-callback)
118+
: πŸ”΄ Not implemented.
119+
120+
[`fork(modulePath[, args][, options])`](https://nodejs.org/api/child_process.html#child_processforkmodulepath-args-options)
121+
: πŸ”΄ Not implemented.
122+
123+
[`spawn(command[, args][, options])`](https://nodejs.org/api/child_process.html#child_processspawncommand-args-options)
124+
: πŸ”΄ Not implemented.
125+
126+
### Process Creation (Synchronous)
127+
128+
[`execFileSync(file[, args][, options])`](https://nodejs.org/api/child_process.html#child_processexecfilesyncfile-args-options)
129+
: 🟒 Supported.
130+
131+
[`execSync(command[, options])`](https://nodejs.org/api/child_process.html#child_processexecsynccommand-options)
132+
: 🟒 Supported.
133+
134+
[`spawnSync(command[, args][, options])`](https://nodejs.org/api/child_process.html#child_processspawnsynccommand-args-options)
135+
: πŸ”΄ Not implemented.

0 commit comments

Comments
Β (0)