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
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,11 +17,11 @@ To install the package, run:
17
17
18
18
`npm install --save baseline-browser-mapping`
19
19
20
-
`baseline-browser-mapping` depends on `web-features` and `@mdn/browser-compat-data` for version selection. It is strongly recommended that you update this module and it's dependencies often to ensure you have the most accurate data. Consider adding a script to your `package.json` and using it as a build step:
20
+
`baseline-browser-mapping` depends on `web-features` and `@mdn/browser-compat-data` for version selection. This package uses dependabot to automatically update both modules on all minor and patch version releases and is updated frequently. Consider adding a script to your `package.json` to update `basesline-browser-mapping` and using it as a build step:
21
21
22
22
```javascript
23
23
"scripts": [
24
-
"refresh-baseline-browser-mapping":"npm i --save baseline-browser-mapping@latest web-features@latest @mdn/browser-compat-data@latest"
24
+
"refresh-baseline-browser-mapping":"npm i --save baseline-browser-mapping@latest"
25
25
]
26
26
```
27
27
@@ -133,7 +133,7 @@ Setting `includeDownstreamBrowsers` to `true` will include browsers outside of t
133
133
134
134
```javascript
135
135
getCompatibleVersions({
136
-
widelyAvailableOnDate:`2023-04-05`,
136
+
includeDownstreamBrowsers:true,
137
137
});
138
138
```
139
139
@@ -175,6 +175,8 @@ By default, this function returns an `Array` of `Objects` and excludes downstrea
175
175
]
176
176
```
177
177
178
+
For browser versions in `@mdn/browser-compat-data` that were released before Baseline can be defined, i.e. Baseline 2015, the `year` property is always the string: `"pre_baseline"`.
179
+
178
180
### Understanding which browsers support Newly available features
179
181
180
182
You may want to understand which recent browser versions support all Newly available features. You can replace the `wa_compatible` property with a `supports` property using the `useSupport` option:
@@ -185,13 +187,12 @@ getAllVersions({
185
187
});
186
188
```
187
189
188
-
The `supports` property has three possible values:
190
+
The `supports` property is optional and has two possible values:
189
191
190
-
-`year_only` for browser versions that do not support all Baseline Widely available Newly Available features.
191
192
-`widely` for browser versions that support all Widely available features.
192
193
-`newly` for browser versions that support all Newly available features.
193
194
194
-
Browser versions that support all Newly available features also support all Widely available features.
195
+
Browser versions that do not support Widely or Newly available will not include the `support` property in the `array` or `object` outputs, and in the CSV output, the `support` column will contain an empty string. Browser versions that support all Newly available features also support all Widely available features.
195
196
196
197
### `getAllVersions()` Configuration options
197
198
@@ -251,7 +252,6 @@ In thise case, `getAllVersions()` returns a nested object with the browser [IDs
251
252
"chrome": {
252
253
"53": {
253
254
"year":2016,
254
-
"supports":"year_only",
255
255
"release_date":"2016-09-07"
256
256
},
257
257
...
@@ -266,7 +266,6 @@ Downstream browsers will include extra fields for `engine` and `engine_versions`
0 commit comments