Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork1.2k
Detect Browsers, OS, Devices, Bots, AI Crawlers, Apps, and more. Run in Browser (client-side) or Node.js (server-side).
License
faisalman/ua-parser-js
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
JavaScript library to detect Browser, Engine, OS, CPU, and Device type/model from User-Agent data with relatively small footprint (~17KB minified, ~6KB gzipped) that can be used either in browser (client-side) or node.js (server-side).
- Author : Faisal Salman <f@faisalman.com>
- Demo :https://faisalman.github.io/ua-parser-js
- Source :https://github.com/faisalman/ua-parser-js
typeofuser-agent "string".
typeofextensions "array".
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 thewindow.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"].
When you callUAParser with thenew keywordUAParser 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([uastring][,extensions])
letparser=newUAParser("user-agent");// you need to pass the user-agent for nodejsconsole.log(parser);// {}letparserResults=parser.getResult();console.log(parserResults);/** { "ua": "", "browser": {}, "engine": {}, "os": {}, "device": {}, "cpu": {}} */
When you call UAParser without thenew keyword, it will automatically callgetResult() function and return the parsed results.
UAParser([uastring][,extensions])- returns result object
{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }
- returns result object
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: {} }
- returns
getBrowser()- returns
{ name: '', version: '' }
- returns
# Possible 'browser.name':2345Explorer, 360 Browser, Amaya, Android Browser, Arora, Avant, Avast, AVG,BIDUBrowser, Baidu, Basilisk, Blazer, Bolt, Brave, Bowser, Camino, Chimera,Chrome Headless, Chrome WebView, Chrome, Chromium, Comodo Dragon, Dillo,Dolphin, Doris, DuckDuckGo, Edge, Electron, Epiphany, Facebook, Falkon, Fennec, Firebird, Firefox [Focus/Reality], Flock, Flow, GSA, GoBrowser, Huawei Browser, ICE Browser, IE, IEMobile, IceApe, IceCat, IceDragon, Iceweasel, Instagram, Iridium, Iron, Jasmine, K-Meleon, Kindle, Klar, Konqueror, LBBROWSER, Line, LinkedIn, Links, Lunascape, Lynx, MIUI Browser, Maemo Browser, Maemo, Maxthon, MetaSr Midori, Minimo, Mobile Safari, 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, Safari, Sailfish Browser, Samsung Browser, SeaMonkey, Silk, Skyfire, Sleipnir, Slim, SlimBrowser, Swiftfox, Tesla, Tizen Browser, UCBrowser, UP.Browser, Vivaldi, Waterfox, WeChat, Weibo, Yandex, baidu, iCab, w3m, Whale Browser...# 'browser.version' determined dynamically
getDevice()- returns
{ model: '', type: '', vendor: '' }
- returns
# Possible 'device.type':console, mobile, tablet, smarttv, wearable, embedded########### NOTE: 'desktop' is not a possible device type.# UAParser only reports info directly available from the UA string, which is not the case for 'desktop' device type.# If you wish to detect desktop devices, you must handle the needed logic yourself.# You can read more about it in this issue: https://github.com/faisalman/ua-parser-js/issues/182########### Possible 'device.vendor':Acer, Alcatel, Amazon, Apple, Archos, ASUS, AT&T, BenQ, BlackBerry, Dell,Essential, Fairphone, GeeksPhone, Google, HP, HTC, Huawei, Jolla, 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, ...# 'device.model' determined dynamically
getEngine()- returns
{ name: '', version: '' }
- returns
# Possible 'engine.name'Amaya, Blink, EdgeHTML, Flow, Gecko, Goanna, iCab, KHTML, Links, Lynx, NetFront,NetSurf, Presto, Tasman, Trident, w3m, WebKit# 'engine.version' determined dynamically
getOS()- returns
{ name: '', version: '' }
- returns
# Possible 'os.name'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, Nintendo, OpenBSD, OpenVMS, OS/2, Palm, PC-BSD, PCLinuxOS, Plan9, PlayStation, QNX, Raspbian, RedHat, RIM Tablet OS, RISC OS, Sabayon, Sailfish, Series40, Slackware, Solaris, SUSE, Symbian, Tizen, Ubuntu, Unix, VectorLinux, WebOS, Windows [Phone/Mobile], Zenwalk, ...# 'os.version' determined dynamically
getCPU()- returns
{ architecture: '' }
- returns
# Possible 'cpu.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
<!doctype html><html><head><scriptsrc="ua-parser.min.js"></script><script>varparser=newUAParser();console.log(parser.getResult());/* /// This will print an object structured like this: { ua: "", browser: { name: "", version: "", major: "" //@deprecated }, engine: { name: "", version: "" }, os: { name: "", version: "" }, device: { model: "", type: "", vendor: "" }, cpu: { architecture: "" } } */// Default result depends on current window.navigator.userAgent value// Now let's try a custom user-agent string as an examplevaruastring1="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";parser.setUA(uastring1);varresult=parser.getResult();// You can also use UAParser constructor directly without having to create an instance:// var result = UAParser(uastring1);console.log(result.browser);// {name: "Chromium", version: "15.0.874.106"}console.log(result.device);// {model: undefined, type: undefined, vendor: undefined}console.log(result.os);// {name: "Ubuntu", version: "11.10"}console.log(result.os.version);// "11.10"console.log(result.engine.name);// "WebKit"console.log(result.cpu.architecture);// "amd64"// Do some other testsvaruastring2="Mozilla/5.0 (compatible; Konqueror/4.1; OpenBSD) KHTML/4.1.4 (like Gecko)";console.log(parser.setUA(uastring2).getBrowser().name);// "Konqueror"console.log(parser.getOS());// {name: "OpenBSD", version: undefined}console.log(parser.getEngine());// {name: "KHTML", version: "4.1.4"}varuastring3='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(parser.setUA(uastring3).getDevice().model);// "PlayBook"console.log(parser.getOS())// {name: "RIM Tablet OS", version: "1.0.0"}console.log(parser.getBrowser().name);// "Safari"</script></head><body></body></html>
Note: Device information is not available in the NodeJS environment.
$ npm install ua-parser-js
varhttp=require('http');varparser=require('ua-parser-js');http.createServer(function(req,res){// get user-agent headervarua=parser(req.headers['user-agent']);// write the result as responseres.end(JSON.stringify(ua,null,' '));}).listen(1337,'127.0.0.1');console.log('Server running at http://127.0.0.1:1337/');
$ npm install --save @types/ua-parser-js# Download TS type definition from DefinitelyTyped repository:# https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ua-parser-js
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 withwindow.UAParser constructor. To get/set user-agent you can use:$.ua.get() /$.ua.set(uastring).
// Say we are in a browser with default user-agent: 'Mozilla/5.0 (Linux; U; Android 2.3.4; en-us; Sprint APA7373KT Build/GRJ22) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0':// Get the detailsconsole.log($.ua.device);// {vendor: "HTC", model: "Evo Shift 4G", type: "mobile"}console.log($.ua.os);// {name: "Android", version: "2.3.4"}console.log($.ua.os.name);// "Android"console.log($.ua.get());// "Mozilla/5.0 (Linux; U; Android 2.3.4; en-us; Sprint APA7373KT Build/GRJ22) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0"// Now lets try to reset to another custom user-agent$.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');// Test againconsole.log($.ua.browser.name);// "Safari"console.log($.ua.engine.name);// "Webkit"console.log($.ua.device);// {vendor: "Motorola", model: "Xoom", type: "tablet"}console.log(parseInt($.ua.browser.version.split('.')[0],10));// 4// Add class to <body> tag// <body>$('body').addClass('ua-browser-'+$.ua.browser.name+' ua-devicetype-'+$.ua.device.type);
UAParser([uastring,] extensions)
// Example:varmyOwnListOfBrowsers=[[/(mybrowser)\/([\w\.]+)/i],[UAParser.BROWSER.NAME,UAParser.BROWSER.VERSION]];varmyParser=newUAParser({browser:myOwnListOfBrowsers});varmyUA='Mozilla/5.0 MyBrowser/1.3';console.log(myParser.setUA(myUA).getBrowser());// {name: "MyBrowser", version: "1.3"}
Made withcontributors-img.
- 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
developbranch
MIT License
Copyright (c) 2012-2021 Faisal Salman <f@faisalman.com>
Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, 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 THESOFTWARE.
About
Detect Browsers, OS, Devices, Bots, AI Crawlers, Apps, and more. Run in Browser (client-side) or Node.js (server-side).
Topics
Resources
License
Code of conduct
Contributing
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.
