fixup! add doc

nodejs · nodejs-github-bot · Feb 7, 2023 · Feb 4, 2023 · Feb 4, 2023 · Feb 4, 2023
commit 0a58ffc057cdbecc7965092e95d829d54110ebe1
diff --git a/doc/api/util.md b/doc/api/util.md
@@ -1989,6 +1989,35 @@ const channel = new MessageChannel();
 channel.port2.postMessage(signal, [signal]);
 ```
 
+## `util.aborted(signal, resource)`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+* `signal` {AbortSignal}
+* `resource` {any} Any non-null entity
+* Returns: {Promise}
+
+Listens to abort event on the provided `signal` and returns a promise which is
+resolved if an abort event is triggered. The function cleans up any
+event listeners depending on when the provided `resource` is garbage collected.
+
+```js
+const { aborted } = require('util');
+
+const ac = new AbortController();
+const dependent = {};
+
+aborted(ac.signal, dependent).then(() => {
+  // Do something when the abort event is triggered.
+});
+
+doSomething(dependent, ac.signal); // Can trigger the abort event
+```
+
 ## `util.types`
 
 <!-- YAML