baseline-browser-mapping 2.0.0-beta.1 → 2.0.0

package/dist/scripts/baseline-browser-versions.d.ts

@@ -6,9 +6,25 @@ type BrowserVersion = {
     engine_version?: string;
 };
 type Options = {
+    /**
+     * Whether to include only the minimum compatible browser versions or all compatible versions.
+     * Defaults to `false`.
+     */
     listAllCompatibleVersions?: boolean;
+    /**
+     * Whether to include browsers that use the same engines as a core Baseline browser.
+     * Defaults to `false`.
+     */
     includeDownstreamBrowsers?: boolean;
+    /**
+     * Pass a date in the format 'YYYY-MM-DD' to get versions compatible with Widely available on the specified date.
+     * If left undefined and a `targetYear` is not passed, defaults to Widely Available as of the current date.
+     */
     widelyAvailableOnDate?: string | number;
+    /**
+     * Pass a year between 2016 and the current year to get browser versions compatible with all
+     * Newly Available features as of the end of the year specified.
+     */
     targetYear?: number;
 };
 export declare function getCompatibleVersions(userOptions: Options): BrowserVersion[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "baseline-browser-mapping",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0",
   "description": "A library for obtaining browser versions with their maximum supported Baseline feature set and Widely Available status.",
   "exports": {
     ".": "./dist/index.js"
@@ -24,5 +24,9 @@
   "devDependencies": {
     "@types/node": "^22.13.5",
     "typescript": "^5.7.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tonypconway/web-features/tree/main/packages/baseline-browser-mapping"
   }
 }