lib: add AbortSignal.timeout

Refs: whatwg/dom#1032 Signed-off-by: James M Snell <jasnell@gmail.com>
nodejs · Nov 24, 2021 · 820e505 · 820e505
1 parent 7633c86
commit 820e505
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 0 deletions.
diff --git a/doc/api/globals.md b/doc/api/globals.md
@@ -104,6 +104,17 @@ changes:
 
 Returns a new already aborted `AbortSignal`.
 
+#### Static method: `AbortSignal.timeout(delay)`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+* `delay` {number} The number of milliseconds to wait before triggering
+  the AbortSignal.
+
+Returns a new `AbortSignal` which will be aborted in `delay` milliseconds.
+
 #### Event: `'abort'`
 
 <!-- YAML

diff --git a/lib/internal/abort_controller.js b/lib/internal/abort_controller.js
@@ -29,8 +29,19 @@ const {
   }
 } = require('internal/errors');
 
+const {
+  validateUint32,
+} = require('internal/validators');
+
+const {
+  DOMException,
+} = internalBinding('messaging');
+
+const { setTimeout } = require('timers');
+
 const kAborted = Symbol('kAborted');
 const kReason = Symbol('kReason');
+const kTimeout = Symbol('kTimeout');
 
 function customInspect(self, obj, depth, options) {
   if (depth < 0)
@@ -82,6 +93,23 @@ class AbortSignal extends EventTarget {
   static abort(reason) {
     return createAbortSignal(true, reason);
   }
+
+  /**
+   * @param {number} delay
+   * @returns {AbortSignal}
+   */
+  static timeout(delay) {
+    validateUint32(delay, 'delay', true);
+    const signal = createAbortSignal();
+    signal[kTimeout] = setTimeout(() => {
+      abortSignal(
+        signal,
+        new DOMException(
+          'The operation was aborted due to timeout',
+          'TimeoutError'));
+    }, delay);
+    return signal;
+  }
 }
 
 ObjectDefineProperties(AbortSignal.prototype, {

diff --git a/test/parallel/test-abortcontroller.js b/test/parallel/test-abortcontroller.js
@@ -153,3 +153,14 @@ const { ok, strictEqual, throws } = require('assert');
   const signal = AbortSignal.abort('reason');
   strictEqual(signal.reason, 'reason');
 }
+
+{
+  // Test AbortSignal timeout
+  const signal = AbortSignal.timeout(10);
+  ok(!signal.aborted);
+  setTimeout(common.mustCall(() => {
+    ok(signal.aborted);
+    strictEqual(signal.reason.name, 'TimeoutError');
+    strictEqual(signal.reason.code, 23);
+  }), 20);
+}