Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/browserslist/browserslist-useragent
🦔A utility to match a browserslist query with user agent strings
https://github.com/browserslist/browserslist-useragent
browserlist-query browserslist useragent
Last synced: 37 minutes ago
JSON representation
🦔A utility to match a browserslist query with user agent strings
- Host: GitHub
- URL: https://github.com/browserslist/browserslist-useragent
- Owner: browserslist
- License: mit
- Created: 2017-10-18T09:13:20.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T17:40:07.000Z (almost 2 years ago)
- Last Synced: 2024-12-16T12:37:57.221Z (7 days ago)
- Topics: browserlist-query, browserslist, useragent
- Language: TypeScript
- Homepage:
- Size: 4.22 MB
- Stars: 300
- Watchers: 6
- Forks: 30
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Browserslist Useragent
[](https://www.npmjs.com/package/browserslist-useragent)
Find if a given user agent string satisfies a [browserslist](https://github.com/ai/browserslist) query.
It automatically reads the browserslist configuration specified in your project,
but you can also specify the same using the `options` parameter.
**If you wish to target modern browsers, read [this](#when-querying-for-modern-browsers).**
## Installation
Note, `browserslist` is a peer dependency, so make sure you have that installed in your project.
```bash
npm install browserslist-useragent
# or
yarn add browserslist-useragent
```
## Usage
```js
const { matchesUA } = require('browserslist-useragent')
matchesUA(userAgentString, options)
// with browserslist config inferred
matchesUA('Mozilla/5.0 (Windows NT 10.0; rv:54.0) Gecko/20100101 Firefox/54.0')
//returns boolean
// with explicit browserslist
matchesUA(
'Mozilla/5.0 (Windows NT 10.0; rv:54.0) Gecko/20100101 Firefox/54.0',
{ browsers: ['Firefox > 53'] }
)
// returns true
```
| Option | Default Value | Description |
| ------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| browsers | — | Manually provide a browserslist query (or an array of queries). Specifying this overrides the browserslist configuration specified in your project. |
| env | — | When multiple browserslist [environments](https://github.com/ai/browserslist#environments) are specified, pick the config belonging to this environment. |
| path | `process.cwd()` | Specify a folder to search for the browserslist config (if it differs from the current working directory) |
| ignorePatch | `true` | Ignore differences in patch browser numbers |
| ignoreMinor | `false` | Ignore differences in minor browser versions |
| allowHigherVersions | `false` | For all the browsers in the browserslist query, return a match if the user agent version is equal to or higher than the one specified in browserslist. See [why](#when-querying-for-modern-browsers) this might be useful. |
## Supported browsers
- Chrome (Chrome / Chromium / Yandex) as `and_chr` | `ChromeAndroid` | `Chrome`
- Samsung Internet as `Samsung`
- Firefox as `ff` | `and_ff` | `FirefoxAndroid` | `Firefox`
- Safari iOS as `ios_saf` | `iOS`
- Safari Desktop as `Safari`
- IE as `ie` | `ie_mob`
- Edge as `Edge`
- Electron as `Electron`
PRs to add more _browserslist supported_ browsers are welcome 👋
## Notes
- All browsers on iOS (Chrome, Firefox etc) use Safari's WebKit as the underlying engine, and hence will be resolved to Safari. Since `browserslist` is usually used for
transpiling / autoprefixing for browsers, this behaviour is what's intended in most cases, but might surprise you otherwise.
- Right now, Chrome for Android and Firefox for Android are resolved to their desktop equivalents. The `caniuse` database does not currently store historical data for these browsers separately (except the last version) See [#156](https://github.com/ai/browserslist/issues/156). However,
safari for iOS and desktop can be matched separately, since this data is available for both.
## When querying for modern browsers
- It is a good idea to update this package often so that browser definitions are upto date.
- It is also a good idea to add `unreleased versions` to your browserslist query, and set `ignoreMinor` and `ignorePatch` to true so that alpha / beta / canary versions of browsers are matched.
- In case you're unable to keep this package up-to-date, you can set the `allowHigherVersions` to `true`. For all the browsers specified in your browserslist query, this will return a match if the user agent version is equal to or higher than those specified in your browserslist query. Use this with care though, since it's a wildcard, and only lightly tested.
## Further reads
- [Smart Bundling: Shipping legacy code to only legacy browsers](https://www.smashingmagazine.com/2018/10/smart-bundling-legacy-code-browsers/)