Skip to content
πŸ¦”A utility to match a browserslist query with user agent strings
JavaScript
Branch: master
Clone or download
bstuff and pastelsky Update README.md
Co-Authored-By: Shubham Kanodia <shubham.kanodia10@gmail.com>
Latest commit bc5cec5 Sep 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tests
.babelrc Refactored code and rewrote Readme Nov 1, 2017
.gitignore
.npmignore Added empty npmignore Nov 2, 2017
.travis.yml
CHANGELOG.md Adds changelog, updates README and dependencies Dec 15, 2018
LICENSE
README.md Update README.md Sep 29, 2019
index.js allow to specify path in browserslist options Sep 29, 2019
logo.svg Refactored code and rewrote Readme Nov 1, 2017
package.json v3.0.2 Jul 31, 2019
yarn.lock Fixes #41 Minor version ranges not respected Jul 31, 2019

README.md

Browserslist Useragent

Travis npm

Browserslist Useragent logo (original by Anton Lovchikov)

Find if a given user agent string satisfies a 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.

Installation

npm install browserslist-useragent

Usage

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 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 this might be useful.

Supported browsers

| Browser Family | Browserslist

  • 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

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. 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

You can’t perform that action at this time.