UAParser.js
JavaScript library to detect Browser, Engine, OS, CPU, and Device type/model from User-Agent & Client-Hints data that can be used either in browser (client-side) or node.js (server-side).
| ↗ @51degrees/ua-parser-js |
UAParser.js has been upgraded to detect comprehensive device data based on the User-Agent and User-Agent Client Hints. This package supports all device types including Apple and Android devices and can be used either in a browser (client-side) or Node.js environment (server-side). Visit ↗ 51Degrees UAParser to get started.
|
↗ Become a sponsor
|
Version 2.0
What's new & breaking, please read CHANGELOG before upgrading.
Documentation
In the browser environment you dont need to pass the user-agent string to the function, you can just call the funtion and it should automatically get the string from the window.navigator.userAgent
, but that is not the case in nodejs. The user-agent string must be passed in' nodejs for the function to work. Usually you can find the user agent in: request.headers["user-agent"]
.
Constructor
When you call UAParser
with the new
keyword, UAParser
will return a new instance with an empty result object, you have to call one of the available methods to get the information from the user-agent string.
Like so:
new UAParser([user-agent:string][,extensions:object][,headers:object(since@2.0)])
let parser = new UAParser("your user-agent here");
console.log(parser);
let parserResults = parser.getResult();
console.log(parserResults);
When you call UAParser without the new
keyword, it will automatically call getResult()
function and return the parsed results.
UAParser([user-agent:string][,extensions:object][,headers:object(since@2.0)])
- returns result object
{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }
Methods
Methods table
The methods are self explanatory, here's a small overview on all the available methods:
-
getResult()
- returns all function object calls, user-agent string, browser info, cpu, device, engine, os:
{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }
.
-
getBrowser()
- returns the browser name and version.
-
getDevice()
- returns the device model, type, vendor.
-
getEngine()
- returns the current browser engine name and version.
-
getOS()
- returns the running operating system name and version.
-
getCPU()
- returns CPU architectural design name.
-
getUA()
- returns the user-agent string.
-
setUA(user-agent)
- set a custom user-agent to be parsed.
-
getResult()
- returns
{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }
-
getBrowser()
- returns
{ name: '', version: '' }
2345Explorer, 360 Browser, Amaya, Android Browser, Arora, Avant, Avast, AVG,
BIDUBrowser, Baidu, Basilisk, Blazer, Bolt, Brave, Bowser, Camino, Chimera,
[Mobile] Chrome [Headless/WebView], Chromium, Cobalt, Comodo Dragon, Dillo,
Dolphin, Doris, DuckDuckGo, Edge, Electron, Epiphany, Facebook, Falkon, Fennec,
Firebird, [Mobile] Firefox [Focus/Reality], Flock, Flow, GSA, GoBrowser, HeyTap,
Huawei Browser, ICE Browser, IE, IEMobile, IceApe, IceCat, IceDragon, Iceweasel,
Instagram, Iridium, Iron, Jasmine, Kakao[Story/Talk], K-Meleon, Kindle, Klar,
Konqueror, LBBROWSER, Line, LinkedIn, Links, Lunascape, Lynx, MIUI Browser,
Maemo Browser, Maemo, Maxthon, MetaSr Midori, Minimo, Mosaic, Mozilla, NetFront,
NetSurf, Netfront, Netscape, NokiaBrowser, Obigo, Oculus Browser, OmniWeb,
Opera Coast, Opera [Mini/Mobi/Tablet], PaleMoon, PhantomJS, Phoenix, Polaris,
Puffin, QQ, QQBrowser, QQBrowserLite, Quark, QupZilla, RockMelt, [Mobile] Safari,
Sailfish Browser, Samsung Browser, SeaMonkey, Silk, Skyfire, Sleipnir, Slim,
SlimBrowser, Swiftfox, Tesla, TikTok, Tizen Browser, UCBrowser, UP.Browser, Viera,
Vivaldi, Waterfox, WeChat, Weibo, Yandex, baidu, iCab, w3m, Whale Browser, ...
getDevice()
- returns
{ model: '', type: '', vendor: '' }
console, mobile, tablet, smarttv, wearable, embedded
Acer, Alcatel, Amazon, Apple, Archos, ASUS, AT&T, BenQ, BlackBerry, Dell,
Essential, Facebook, Fairphone, GeeksPhone, Google, HP, HTC, Huawei, Jolla, Kobo,
Lenovo, LG, Meizu, Microsoft, Motorola, Nexian, Nintendo, Nokia, Nvidia, OnePlus,
OPPO, Ouya, Palm, Panasonic, Pebble, Polytron, Realme, RIM, Roku, Samsung, Sharp,
Siemens, Sony[Ericsson], Sprint, Tesla, Vivo, Vodafone, Xbox, Xiaomi, Zebra, ZTE, ...
getEngine()
- returns
{ name: '', version: '' }
Amaya, Blink, EdgeHTML, Flow, Gecko, Goanna, iCab, KHTML, LibWeb, Links, Lynx,
NetFront, NetSurf, Presto, Tasman, Trident, w3m, WebKit
getOS()
- returns
{ name: '', version: '' }
AIX, Amiga OS, Android[-x86], Arch, Bada, BeOS, BlackBerry, CentOS, Chromium OS,
Contiki, Fedora, Firefox OS, FreeBSD, Debian, Deepin, DragonFly, elementary OS,
Fuchsia, Gentoo, GhostBSD, GNU, Haiku, HarmonyOS, HP-UX, Hurd, iOS, Joli, KaiOS,
Linpus, Linspire,Linux, Mac OS, Maemo, Mageia, Mandriva, Manjaro, MeeGo, Minix,
Mint, Morph OS, NetBSD, NetRange, NetTV, Nintendo, OpenBSD, OpenVMS, OS/2, Palm,
PC-BSD, PCLinuxOS, Plan9, PlayStation, QNX, Raspbian, RedHat, RIM Tablet OS,
RISC OS, Sabayon, Sailfish, SerenityOS, Series40, Slackware, Solaris, SUSE, Symbian,
Tizen, Ubuntu, Unix, VectorLinux, Viera, watchOS, WebOS, Windows [Phone/Mobile],
Zenwalk, ...
getCPU()
- returns
{ architecture: '' }
68k, amd64, arm[64/hf], avr, ia[32/64], irix[64], mips[64], pa-risc, ppc, sparc[64]
-
getUA()
- returns UA string of current instance
-
setUA(uastring)
- set UA string to be parsed
- returns current instance
* is():boolean
utility since@2.0
let ua = UAParser();
let device = ua.device;
let os = ua.os;
if (device.type == "mobile" && os.name != "iOS") {}
if (device.type == "smarttv" || device.vendor == "Samsung") {}
if (device.is("mobile") && !os.is("iOS")) {}
if (device.is("SmartTV") || device.is("SaMsUnG")) {}
let uap = new UAParser('Mozilla/5.0 (Mobile; Windows Phone 8.1; Android 4.0; ARM; Trident/7.0; Touch; rv:11.0; IEMobile/11.0; NOKIA; Lumia 635) like iPhone OS 7_0_3 Mac OS X AppleWebKit/537 (KHTML, like Gecko) Mobile Safari/537');
uap.getBrowser().name;
uap.getBrowser().is("IEMobile");
uap.getCPU().is("ARM");
uap.getOS().name;
uap.getOS().is("Windows Phone");
uap.getDevice();
uap.getResult().device;
let device = uap.getDevice();
device.is("mobile");
device.is("Lumia 635");
device.is("Nokia");
device.is("iPhone");
uap.getResult().device.is("Nokia");
uap.getResult().device.model;
uap.setUA("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36");
let browser = uap.getBrowser();
browser.is("IEMobile");
browser.is("Chrome");
uap.getResult().browser.is("Edge");
uap.getResult().os.name
uap.getResult().os.is("Mac OS");
uap.getResult().os.version;
let engine = uap.getEngine();
engine.is("Blink");
* toString():string
utility since@2.0
let uap = new UAParser('Mozilla/5.0 (Mobile; Windows Phone 8.1; Android 4.0; ARM; Trident/7.0; Touch; rv:11.0; IEMobile/11.0; NOKIA; Lumia 635) like iPhone OS 7_0_3 Mac OS X AppleWebKit/537 (KHTML, like Gecko) Mobile Safari/537');
uap.getDevice();
uap.getDevice().toString();
uap.getResult().os.name;
uap.getResult().os.version;
uap.getResult().os.toString();
uap.setUA("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36");
uap.getBrowser().name;
uap.getBrowser().version;
uap.getBrowser().major;
uap.getBrowser().toString();
let engine = uap.getEngine();
engine.name;
engine.version;
engine.toString();
* withClientHints():Promise<object>|Thenable<object>|object
since@2.0
Recently, Chrome limits the information exposed through user-agent and introduces a new experimental set of data called "client-hints". In browser-environment, obtaining the client-hints data via JavaScript must be done in an asynchronous way. In UAParser
you can chain the result object from get*
method with withClientHints()
to also read the client-hints data from the browser and return the updated data as a Promise
.
(async function () {
let ua = new UAParser();
let browser = ua.getBrowser();
console.log('Using User-Agent: ', browser);
browser = await ua.getBrowser().withClientHints();
console.log('Using Client-Hints: ', browser);
ua.getBrowser().withClientHints().then(function (browser) {
console.log('Using Client-Hints: ', browser);
});
})();
Along with User-Agent
HTTP header, Chrome also sends this client-hints data by default under Sec-CH-UA-*
HTTP headers in each request. In server-side development, you can capture this extra information by passing the req.headers
to UAParser()
(see examples below). When using withClientHints()
in nodejs environment and browser without client-hints support (basically anything that's not Chromium-based), it will returns a new object with updated data.
const request = {
headers : {
'user-agent' : 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36',
'sec-ch-ua-mobile' : '?1',
'sec-ch-ua-model' : 'Galaxy S3 Marketing',
'sec-ch-ua-platform' : 'Android'
}
};
const result1 = UAParser(request.headers);
const result2 = UAParser(request.headers).withClientHints();
console.log(result1.os.name);
console.log(result1.device.type);
console.log(result1.device.model);
console.log(result2.os.name);
console.log(result2.device.type);
console.log(result2.device.model);
new UAParser(request.headers)
.getBrowser()
.withClientHints()
.then((browser) => {
console.log(browser.toString());
});
Extending Regex
If you want to detect something that's not currently provided by UAParser.js (eg: bots
, specific apps, etc), you can pass a list of regexes to extend internal UAParser.js regexes with your own.
UAParser([uastring,] extensions [,headers:object(since@2.0)])
const myOwnListOfBrowsers = [
[/(mybrowser)\/([\w\.]+)/i], [UAParser.BROWSER.NAME, UAParser.BROWSER.VERSION, ['type', 'bot']]
];
const myUA = 'Mozilla/5.0 MyBrowser/1.3';
let myParser = new UAParser({ browser: myOwnListOfBrowsers });
console.log(myParser.setUA(myUA).getBrowser());
console.log(myParser.getBrowser().is('bot'));
const myOwnListOfDevices = [
[/(mytab) ([\w ]+)/i], [UAParser.DEVICE.VENDOR, UAParser.DEVICE.MODEL, [UAParser.DEVICE.TYPE, UAParser.DEVICE.TABLET]],
[/(myphone)/i], [UAParser.DEVICE.VENDOR, [UAParser.DEVICE.TYPE, UAParser.DEVICE.MOBILE]]
];
const myUA2 = 'Mozilla/5.0 MyTab 14 Pro Max';
let myParser2 = new UAParser({
browser: myOwnListOfBrowsers,
device: myOwnListOfDevices
});
console.log(myParser2.setUA(myUA2).getDevice());
Some basic extensions (although not very complete at the moment) can also be found under ua-parser-js/extensions
submodule.
import { UAParser } from 'ua-parser-js';
import { Emails } from 'ua-parser-js/extensions';
const browser = new UAParser(Emails)
.setUA('Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.13.0')
.getBrowser();
console.log(browser.name);
Usage
Using HTML
<!doctype html>
<html>
<head>
<script src="ua-parser.min.js"></script>
<script>
var uap = new UAParser();
console.log(uap.getResult());
var uastring1 = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/11.10 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2";
uap.setUA(uastring1);
var result = uap.getResult();
console.log(result.browser);
console.log(result.device);
console.log(result.os);
console.log(result.os.version);
console.log(result.engine.name);
console.log(result.cpu.architecture);
var uastring2 = "Mozilla/5.0 (compatible; Konqueror/4.1; OpenBSD) KHTML/4.1.4 (like Gecko)";
console.log(uap.setUA(uastring2).getBrowser().name);
console.log(uap.getOS());
console.log(uap.getEngine());
var uastring3 = 'Mozilla/5.0 (PlayBook; U; RIM Tablet OS 1.0.0; en-US) AppleWebKit/534.11 (KHTML, like Gecko) Version/7.1.0.7 Safari/534.11';
console.log(uap.setUA(uastring3).getDevice().model);
console.log(uap.getOS())
console.log(uap.getBrowser().name);
</script>
</head>
<body>
</body>
</html>
Using node.js
Note: Device information is not available in the NodeJS environment.
$ npm install ua-parser-js
var http = require('http');
var uap = require('ua-parser-js');
http.createServer(function (req, res) {
var ua = uap(req.headers['user-agent']);
res.end(JSON.stringify(ua, null, ' '));
})
.listen(1337, '127.0.0.1');
console.log('Server running at http://127.0.0.1:1337/');
Using ES Modules
import { UAParser } from 'ua-parser-js';
const { browser, cpu, device } = UAParser('Mozilla/5.0 (X11; U; Linux armv7l; en-GB; rv:1.9.2a1pre) Gecko/20090928 Firefox/3.5 Maemo Browser 1.4.1.22 RX-51 N900');
console.log(browser.name);
console.log(cpu.is('arm'));
console.log(device.is('mobile'));
console.log(device.model);
Using TypeScript
$ npm install --save @types/ua-parser-js
Using jQuery/Zepto ($.ua)
Although written in vanilla js, this library will automatically detect if jQuery/Zepto is present and create $.ua
object (with values based on its User-Agent) along with window.UAParser
constructor. To get/set user-agent you can use: $.ua.get()
/ $.ua.set(uastring)
.
console.log($.ua.device);
console.log($.ua.os);
console.log($.ua.os.name);
console.log($.ua.get());
$.ua.set('Mozilla/5.0 (Linux; U; Android 3.0.1; en-us; Xoom Build/HWI69) AppleWebKit/534.13 (KHTML, like Gecko) Version/4.0 Safari/534.13');
console.log($.ua.browser.name);
console.log($.ua.engine.name);
console.log($.ua.device);
console.log(parseInt($.ua.browser.version.split('.')[0], 10));
$('body').addClass('ua-browser-' + $.ua.browser.name + ' ua-devicetype-' + $.ua.device.type);
Development
Contributors
Made with contributors-img.
How To Contribute
- Fork and clone this repository
- Make some changes as required
- Write unit test to showcase its functionality
- Run the test suites to make sure it's not breaking anything
$ npm test
- Submit a pull request under
develop
branch
License
MIT License
Copyright (c) 2012-2023 Faisal Salman <f@faisalman.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.