doc: recommend checking abortSignal.aborted first

Signed-off-by: James M Snell <[email protected]> PR-URL: #37714 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Rich Trott <[email protected]>
nodejs · Mar 16, 2021 · 1022d3d · 1022d3d
1 parent 12fb2ff
commit 1022d3d
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/doc/api/globals.md b/doc/api/globals.md
@@ -91,11 +91,15 @@ ac.abort();
 ```
 
 The `AbortController` with which the `AbortSignal` is associated will only
-ever trigger the `'abort'` event once. Any event listeners attached to the
-`AbortSignal` *should* use the `{ once: true }` option (or, if using the
-`EventEmitter` APIs to attach a listener, use the `once()` method) to ensure
-that the event listener is removed as soon as the `'abort'` event is handled.
-Failure to do so may result in memory leaks.
+ever trigger the `'abort'` event once. We recommended that code check
+that the `abortSignal.aborted` attribute is `false` before adding an `'abort'`
+event listener.
+
+Any event listeners attached to the `AbortSignal` should use the
+`{ once: true }` option (or, if using the `EventEmitter` APIs to attach a
+listener, use the `once()` method) to ensure that the event listener is
+removed as soon as the `'abort'` event is handled. Failure to do so may
+result in memory leaks.
 
 #### `abortSignal.aborted`
 <!-- YAML