You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,17 @@
1
1
# types-web
2
2
3
+
Get types for the latest web APIs as soon as they become widely available!
4
+
3
5

4
6
7
+
[The default types generator](https://github.com/microsoft/TypeScript-DOM-lib-generator/) for TypeScript requires manual review for every update, and thus does not provide types for every latest API in a timely manner. `types-web` solves this issue by deploying automation by following tools:
8
+
9
+
*[`@mdn/browser-compat-data`](https://www.npmjs.com/package/@mdn/browser-compat-data) provides which features are supported by which browsers, so that undersupported features can be disabled automatically.
10
+
*[`browser-specs`](https://www.npmjs.com/package/browser-specs) provides a full list of web specs, so that every latest feature can be covered.
11
+
*[`webref`](https://github.com/w3c/webref) provides IDL code from the specs, so that the features can be properly typed.
12
+
13
+
See how many types have been added in the [changelog](CHANGELOG.md).
14
+
5
15
## How to use
6
16
7
17
1. Install the package by [`npm i types-web`](https://www.npmjs.com/package/types-web).
@@ -25,18 +35,6 @@
25
35
}
26
36
```
27
37
28
-
## How is this different from [TypeScript-DOM-lib-generator](https://github.com/microsoft/TypeScript-DOM-lib-generator/)?
29
-
30
-
`types-web` tries automating everything with a set of relevant tools to reduce the hassle of manual reviewing:
31
-
32
-
* [`@mdn/browser-compat-data`](https://www.npmjs.com/package/@mdn/browser-compat-data) provides which features are supported by which browsers, so that undersupported features can be disabled automatically.
33
-
* [`browser-specs`](https://www.npmjs.com/package/browser-specs) provides a full list of web specs, so that every latest feature can be covered.
34
-
* [`webref`](https://github.com/w3c/webref) provides IDL code from the specs, so that the features can be properly typed.
35
-
36
-
But so far some things still need manual modification and that is done by files in`inputfiles/` directory.
37
-
38
-
See how many types have been added in the [changelog](CHANGELOG.md).
39
-
40
38
## Why not `@types`?
41
39
42
40
To maintain the package by myself without waiting for external reviews.
@@ -47,6 +45,10 @@ A feature needs to be supported by more than two major browser engines to be inc
47
45
48
46
If the condition is met but still is not available here, please [file an issue](https://github.com/saschanaz/types-web/issues/new).
49
47
48
+
## Is it fully automated?
49
+
50
+
Not yet. A small part of things still needs manual modification, which is done by files in`inputfiles/` directory.
0 commit comments