sindresorhus · sindresorhus · Aug 21, 2024 · Aug 20, 2024 · Aug 20, 2024 · Aug 20, 2024
diff --git a/index.d.ts b/index.d.ts
@@ -15,15 +15,28 @@ declare const domLoaded: Promise<void> & {
 	/**
 	Synchronously check if the DOM has already finished loading.
 
+	@example
 	```
 	import domLoaded from 'dom-loaded';
 
 	if (domLoaded.hasLoaded) {
-		console.log('The DOM has already finished loading.')
+		console.log('The DOM has already finished loading.');
 	}
 	```
 	*/
 	readonly hasLoaded: boolean;
+
+	/**
+	An `AbortSignal` that triggers when the DOM finishes loading or immediately if it has already loaded.
+
+	@example
+	```
+	import domLoaded from 'dom-loaded';
+
+	showLoader({signal: domLoaded.signal});
+	```
+	*/
+	readonly signal: AbortSignal;
 };
 
 export default domLoaded;
diff --git a/index.js b/index.js
@@ -1,11 +1,15 @@
 const hasLoaded = () => document.readyState === 'interactive' || document.readyState === 'complete';
 
+const controller = new AbortController();
+
 const domLoaded = new Promise(resolve => {
 	if (hasLoaded()) {
 		resolve();
+		controller.abort();
 	} else {
 		document.addEventListener('DOMContentLoaded', () => {
 			resolve();
+			controller.abort();
 		}, {
 			capture: true,
 			once: true,
@@ -17,5 +21,9 @@ const domLoaded = new Promise(resolve => {
 export default domLoaded;
 
 Object.defineProperty(domLoaded, 'hasLoaded', {
-	get: () => hasLoaded(),
+	get: hasLoaded,
+});
+
+Object.defineProperty(domLoaded, 'signal', {
+	get: () => controller.signal,
 });
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -3,3 +3,4 @@ import domLoaded from './index.js';
 
 expectAssignable<Promise<void>>(domLoaded);
 expectType<boolean>(domLoaded.hasLoaded);
+expectType<AbortSignal>(domLoaded.signal);
diff --git a/readme.md b/readme.md
@@ -33,6 +33,12 @@ Type: `boolean`
 
 Synchronously check if the DOM has already finished loading.
 
+### domLoaded.signal
+
+Type: [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
+
+An `AbortSignal` that triggers when the DOM finishes loading or immediately if it has already loaded.
+
 ## Related
 
 - [element-ready](https://github.com/sindresorhus/element-ready) - Detect when an element is ready in the DOM
diff --git a/test.js b/test.js
@@ -63,3 +63,18 @@ test('domLoaded.hasLoaded', async t => {
 
 	t.true(window.domLoaded.hasLoaded);
 });
+
+test('domLoaded.signal', async t => {
+	const {window} = new JSDOM('<body></body>', {
+		runScripts: 'outside-only',
+	});
+
+	const loadedPromise = new Promise(resolve => {
+		window.document.addEventListener('DOMContentLoaded', resolve);
+	});
+
+	await loadedPromise;
+	window.eval(umdWrappedDomLoaded);
+
+	t.true(window.domLoaded.signal.aborted);
+});
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,3 +3,4 @@ import domLoaded from './index.js';

		expectAssignable<Promise<void>>(domLoaded);
		expectType<boolean>(domLoaded.hasLoaded);
		expectType<AbortSignal>(domLoaded.signal);