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: src/scripts/baseline-browser-versions.ts
+7-6Lines changed: 7 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -356,7 +356,7 @@ type Options = {
356
356
/**
357
357
* Returns browser versions compatible with specified Baseline targets.
358
358
* Defaults to returning the minimum versions of the core browser set that support Baseline Widely available.
359
-
* Takes an optional configuration object `Object` with four optional properties:
359
+
* Takes an optional configuration `Object` with four optional properties:
360
360
* - `listAllCompatibleVersions`: `false` (default) or `false`
361
361
* - `includeDownstreamBrowsers`: `false` (default) or `false`
362
362
* - `widelyAvailableOnDate`: date in format `YYYY-MM-DD`
@@ -416,8 +416,8 @@ export function getCompatibleVersions(userOptions?: Options): BrowserVersion[] {
416
416
417
417
typeAllVersionsOptions={
418
418
/**
419
-
* Whether to return the output as a JavaScript `Array` (`array`) or a CSV string (`csv`).
420
-
* Defaults to `array`.
419
+
* Whether to return the output as a JavaScript `Array` (`"array"`), `Object` (`"object"`) or a CSV string (`"csv"`).
420
+
* Defaults to `"array"`.
421
421
*/
422
422
outputFormat?: string;
423
423
/**
@@ -433,10 +433,11 @@ type AllVersionsOptions = {
433
433
};
434
434
435
435
/**
436
-
* Returns all browser versions known to this module with their level of Baseline support either as an `Array` or a `String` CSV.
437
-
* Takes an object as an argument with two optional properties:
436
+
* Returns all browser versions known to this module with their level of Baseline support as a JavaScript `Array` (`"array"`), `Object` (`"object"`) or a CSV string (`"csv"`).
437
+
* Takes an optional configuration `Object` with three optional properties:
438
438
* - `includeDownstreamBrowsers`: `true` (default) or `false`
439
-
* - `outputFormat`: `array` (default), `object` or `csv`
439
+
* - `outputFormat`: `"array"` (default), `"object"` or `"csv"`
440
+
* - `useSupports`: `false` (default) or `true`, replaces `wa_compatible` property with optional `supports` property which returns `widely` or `newly` available when present.
0 commit comments