-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathindex.d.ts
42 lines (33 loc) · 986 Bytes
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/**
Check when the DOM has loaded like [`DOMContentLoaded`](https://developer.mozilla.org/en/docs/Web/Events/DOMContentLoaded). Unlike `DOMContentLoaded`, this also works when included after the DOM was loaded.
The promise resolves when the DOM finishes loading or right away if the DOM has already loaded.
@example
```
import domLoaded from 'dom-loaded';
await domLoaded;
console.log('The DOM is now loaded.');
```
*/
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.');
}
```
*/
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;