Skip to content

Commit a82b1f5

Browse files
committed
doc: simplify addAbortListener example
The example was written before v8 supported the using keyword and hence explicitly called Symbol.dispose Since now the keyword is supported, the example can be simplified
1 parent a57893b commit a82b1f5

File tree

1 file changed

+8
-18
lines changed

1 file changed

+8
-18
lines changed

doc/api/events.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1908,31 +1908,21 @@ Returns a disposable so that it may be unsubscribed from more easily.
19081908
const { addAbortListener } = require('node:events');
19091909

19101910
function example(signal) {
1911-
let disposable;
1912-
try {
1913-
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
1914-
disposable = addAbortListener(signal, (e) => {
1915-
// Do something when signal is aborted.
1916-
});
1917-
} finally {
1918-
disposable?.[Symbol.dispose]();
1919-
}
1911+
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
1912+
using addAbortListener(signal, (e) => {
1913+
// Do something when signal is aborted.
1914+
});
19201915
}
19211916
```
19221917

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

19261921
function example(signal) {
1927-
let disposable;
1928-
try {
1929-
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
1930-
disposable = addAbortListener(signal, (e) => {
1931-
// Do something when signal is aborted.
1932-
});
1933-
} finally {
1934-
disposable?.[Symbol.dispose]();
1935-
}
1922+
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
1923+
using addAbortListener(signal, (e) => {
1924+
// Do something when signal is aborted.
1925+
});
19361926
}
19371927
```
19381928

0 commit comments

Comments
 (0)