lib: add AbortSignal.timeout

Refs: whatwg/dom#1032 Signed-off-by: James M Snell <jasnell@gmail.com>

Author: jasnell

doc/api/globals.md

@@ -104,6 +104,17 @@ changes:
 
 Returns a new already aborted `AbortSignal`.
 
+#### Static method: `AbortSignal.timeout(delay)`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+* `duration` {number} The numer of milliseconds to wait before triggering
+ the AbortSignal.
+
+Returns a new `AbortSignal` which will be aborted in `delay` milliseconds.
+
 #### Event: `'abort'`
 
 <!-- YAML

lib/internal/abort_controller.js

@@ -29,8 +29,17 @@ const {
  }
 } = require('internal/errors');
 
+const {
+ validateUint32,
+} = require('internal/validators');
+
+const {
+ DOMException,
+} = internalBinding('messaging');
+
 const kAborted = Symbol('kAborted');
 const kReason = Symbol('kReason');
+const kTimeout = Symbol('kTimeout');
 
 function customInspect(self, obj, depth, options) {
  if (depth < 0)
@@ -82,6 +91,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, {

test/parallel/test-abortcontroller.js

@@ -153,3 +153,13 @@ 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(() => {
+ ok(signal.aborted);
+ strictEqual(signal.reason.code, 23);
+ }, 20);
+}