Skip to content

doc: recommend events.once to manage 'close' event #60017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 8, 2025
+10 −6
Merged

doc: recommend events.once to manage 'close' event #60017

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 10 additions & 6 deletions doc/api/child_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ ls.on('close', (code) => {

```mjs
import { spawn } from 'node:child_process';
import { once } from 'node:events';
const ls = spawn('ls', ['-lh', '/usr']);

ls.stdout.on('data', (data) => {
Expand All @@ -39,9 +40,8 @@ ls.stderr.on('data', (data) => {
console.error(`stderr: ${data}`);
});

ls.on('close', (code) => {
console.log(`child process exited with code ${code}`);
});
const [code] = await once(ls, 'close');
console.log(`child process exited with code ${code}`);
```

By default, pipes for `stdin`, `stdout`, and `stderr` are established between
Expand Down Expand Up @@ -772,6 +772,7 @@ ls.on('close', (code) => {

```mjs
import { spawn } from 'node:child_process';
import { once } from 'node:events';
const ls = spawn('ls', ['-lh', '/usr']);

ls.stdout.on('data', (data) => {
Expand All @@ -782,9 +783,8 @@ ls.stderr.on('data', (data) => {
console.error(`stderr: ${data}`);
});

ls.on('close', (code) => {
console.log(`child process exited with code ${code}`);
});
const [code] = await once(ls, 'close');
console.log(`child process exited with code ${code}`);
```

Example: A very elaborate way to run `ps ax | grep ssh`
Expand Down Expand Up @@ -1483,6 +1483,7 @@ ls.on('exit', (code) => {

```mjs
import { spawn } from 'node:child_process';
import { once } from 'node:events';
const ls = spawn('ls', ['-lh', '/usr']);

ls.stdout.on('data', (data) => {
Expand All @@ -1496,6 +1497,9 @@ ls.on('close', (code) => {
ls.on('exit', (code) => {
console.log(`child process exited with code ${code}`);
});

const [code] = await once(ls, 'close');
console.log(`child process close all stdio with code ${code}`);
```

### Event: `'disconnect'`
Expand Down
Loading