Skip to content

doc: simplify addAbortListener example #61842

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

Open
atlowChemi wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −18
Open

doc: simplify addAbortListener example #61842

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
26 changes: 8 additions & 18 deletions doc/api/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1908,31 +1908,21 @@ Returns a disposable so that it may be unsubscribed from more easily.
const { addAbortListener } = require('node:events');

function example(signal) {
let disposable;
try {
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
disposable = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
} finally {
disposable?.[Symbol.dispose]();
}
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
using _ = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
Comment on lines +1912 to +1914
Copy link
Member

@Renegade334 Renegade334 Feb 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be worth adding a comment underneath to state that the abort listener is automatically removed when leaving the scope, otherwise the significance of the using statement doesn't have any immediate context to the casual observer.

}
```

```mjs
import { addAbortListener } from 'node:events';

function example(signal) {
let disposable;
try {
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
disposable = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
} finally {
disposable?.[Symbol.dispose]();
}
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
using _ = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
}
```

Expand Down
Loading