{"id":22863976,"url":"https://github.com/xelzs/mdn-browser-compat-api","last_synced_at":"2025-03-31T09:28:59.648Z","repository":{"id":56412281,"uuid":"311274305","full_name":"Xelzs/mdn-browser-compat-api","owner":"Xelzs","description":"Request the @mdn/browser-compat-data (used by caniuse.com)","archived":false,"fork":false,"pushed_at":"2021-10-25T08:44:37.000Z","size":144,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-08T13:46:34.114Z","etag":null,"topics":["api","browser","browser-compat-api","browser-compat-data","compat","compatibility","mdn"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Xelzs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-09T08:40:36.000Z","updated_at":"2023-09-08T18:14:39.000Z","dependencies_parsed_at":"2022-08-15T18:10:51.401Z","dependency_job_id":null,"html_url":"https://github.com/Xelzs/mdn-browser-compat-api","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xelzs%2Fmdn-browser-compat-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xelzs%2Fmdn-browser-compat-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xelzs%2Fmdn-browser-compat-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xelzs%2Fmdn-browser-compat-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Xelzs","download_url":"https://codeload.github.com/Xelzs/mdn-browser-compat-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246446285,"owners_count":20778769,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","browser","browser-compat-api","browser-compat-data","compat","compatibility","mdn"],"created_at":"2024-12-13T11:18:36.976Z","updated_at":"2025-03-31T09:28:59.626Z","avatar_url":"https://github.com/Xelzs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @xelzs/mdn-browser-compat-api\n\n![Test](https://github.com/xelzs/mdn-browser-compat-api/workflows/test/badge.svg)\n![Publish](https://github.com/xelzs/mdn-browser-compat-api/workflows/publish/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/Xelzs/mdn-browser-compat-api/badge.svg?branch=develop)](https://coveralls.io/github/Xelzs/mdn-browser-compat-api?branch=develop)\n\nRequest the @mdn/browser-compat-data (used by caniuse.com)\n\n## Installation\n\nYou can install `@xelzs/mdn-browser-compat-api` as a node package.\n\n```\n$ npm install @xelzs/mdn-browser-compat-api\n```\n\n## Usage\n\n```js\nconst browserCompatApi = require('@xelzs/mdn-browser-compat-api');\n\nbrowserCompatApi.getFeatures();\nbrowserCompatApi.getFeatures('css');\nbrowserCompatApi.getFolders();\nbrowserCompatApi.getBrowsers();\nbrowserCompatApi.find('fit-content', 'css');\nbrowserCompatApi.get('css.properties.width.fit-content');\nbrowserCompatApi.updateData();\n// ...\n```\n\n## API\n\n### `browserCompatApi.getFeatures(folder)`\n\nGet a list of features from mdn with the formatted paths. You can add an optional parameter `folder` to get features from a [folder](https://github.com/mdn/browser-compat-data#repository-contents).\n\n```js\nbrowserCompatApi.getFeatures();\n/*\n[\n  \"api.AbortController\",\n  \"api.AbortController.AbortController\",\n  \"api.AbortController.abort\",\n  \"api.AbortController.signal\",\n  ...\n]\n*/\n```\n\n### `browserCompatApi.getFolders()`\n\nGet the list of folders inside [@mdn/browser-compat-data](https://github.com/mdn/browser-compat-data).\n\n```js\nbrowserCompatApi.getFolders();\n/*\n[\n  \"api\",\n  \"browsers\",\n  \"css\",\n  \"css.at-rules\",\n  \"css.properties\",\n  \"css.selectors\",\n  \"css.types\",\n  ...\n*/\n```\n\n### `browserCompatApi.getBrowsers()`\n\nGet the list of browsers. You check the schema at [@mdn compat-data-schema.md](https://github.com/mdn/browser-compat-data/blob/master/schemas/compat-data-schema.md)\n\n### `browserCompatApi.find(query, folder)`\n\nSearch for a feature. You can add an optional parameter `folder` to search inside specific [folder](https://github.com/mdn/browser-compat-data#repository-contents).\n\n```js\nbrowserCompatApi.find('fit-content', 'css');\n/*\n[\n  'css.properties.block-size.fit-content',\n  'css.properties.grid-template-columns.fit-content',\n  'css.properties.grid-template-rows.fit-content',\n  'css.properties.height.fit-content',\n  'css.properties.inline-size.fit-content',\n  'css.properties.max-block-size.fit-content',\n  'css.properties.max-height.fit-content',\n  'css.properties.max-inline-size.fit-content',\n  'css.properties.max-width.fit-content',\n  'css.properties.min-block-size.fit-content',\n  'css.properties.min-height.fit-content',\n  'css.properties.min-inline-size.fit-content',\n  'css.properties.min-width.fit-content',\n  'css.properties.width.fit-content'\n]\n*/\n```\n\n### `browserCompatApi.get('css.properties.width.fit-content')`\n\nGet a list of object with corresponding features.  \nYou check the schema at [@mdn compat-data-schema.md](https://github.com/mdn/browser-compat-data/blob/master/schemas/compat-data-schema.md)\n\n### `browserCompatApi.updateData()`\n\nUpdate data files. (By default, generated during installation).\n\n## Changelog\n\nChangelog is accessible in the [CHANGELOG.md](CHANGELOG.md) file or in [the release section](https://github.com/Xelzs/mdn-browser-compat-api/releases).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxelzs%2Fmdn-browser-compat-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxelzs%2Fmdn-browser-compat-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxelzs%2Fmdn-browser-compat-api/lists"}