\n\n# UAParser.js\n\nJavaScript 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).\n\n* Author : Faisal Salman <>\n* Demo : https://faisalman.github.io/ua-parser-js\n* Source : https://github.com/faisalman/ua-parser-js\n\n# Documentation\n### UAParser([user-agent][,extensions])\ntypeof `user-agent` \"string\".\n\ntypeof `extensions` \"array\".\n\nIn 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.\nUsually you can find the user agent in:\n`request.headers[\"user-agent\"]`.\n\n\n## Constructor\nWhen 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.\nLike so:\n* `new UAParser([uastring][,extensions])`\n```js\nlet parser = new UAParser(\"user-agent\"); // you need to pass the user-agent for nodejs\nconsole.log(parser); // {}\nlet parserResults = parser.getResult();\nconsole.log(parserResults);\n/** {\n \"ua\": \"\",\n \"browser\": {},\n \"engine\": {},\n \"os\": {},\n \"device\": {},\n \"cpu\": {}\n} */\n```\n\nWhen you call UAParser without the `new` keyword, it will automatically call `getResult()` function and return the parsed results.\n* `UAParser([uastring][,extensions])`\n * returns result object `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`\n\n## Methods\n\n#### Methods table\nThe methods are self explanatory, here's a small overview on all the available methods:\n* `getResult()` - returns all function object calls, user-agent string, browser info, cpu, device, engine, os:\n`{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`.\n\n * `getBrowser()` - returns the browser name and version.\n * `getDevice()` - returns the device model, type, vendor.\n * `getEngine()` - returns the current browser engine name and version.\n * `getOS()` - returns the running operating system name and version.\n * `getCPU()` - returns CPU architectural design name.\n * `getUA()` - returns the user-agent string.\n * `setUA(user-agent)` - set a custom user-agent to be parsed.\n\n\n---\n\n* `getResult()`\n * returns `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`\n\n* `getBrowser()`\n * returns `{ name: '', version: '' }`\n\n```sh\n# Possible 'browser.name':\n2345Explorer, 360 Browser, Amaya, Android Browser, Arora, Avant, Avast, AVG,\nBIDUBrowser, Baidu, Basilisk, Blazer, Bolt, Brave, Bowser, Camino, Chimera,\nChrome Headless, Chrome WebView, Chrome, Chromium, Comodo Dragon, Dillo,\nDolphin, Doris, DuckDuckGo, Edge, Electron, Epiphany, Facebook, Falkon, Fennec, \nFirebird, Firefox [Focus/Reality], Flock, Flow, GSA, GoBrowser, Huawei Browser, \nICE Browser, IE, IEMobile, IceApe, IceCat, IceDragon, Iceweasel, Instagram, \nIridium, Iron, Jasmine, K-Meleon, Kindle, Klar, Konqueror, LBBROWSER, Line, \nLinkedIn, Links, Lunascape, Lynx, MIUI Browser, Maemo Browser, Maemo, Maxthon, \nMetaSr Midori, Minimo, Mobile Safari, Mosaic, Mozilla, NetFront, NetSurf, Netfront, \nNetscape, NokiaBrowser, Obigo, Oculus Browser, OmniWeb, Opera Coast, \nOpera [Mini/Mobi/Tablet], PaleMoon, PhantomJS, Phoenix, Polaris, Puffin, QQ, \nQQBrowser, QQBrowserLite, Quark, QupZilla, RockMelt, Safari, Sailfish Browser, \nSamsung Browser, SeaMonkey, Silk, Skyfire, Sleipnir, Slim, SlimBrowser, Swiftfox, \nTesla, Tizen Browser, UCBrowser, UP.Browser, Vivaldi, Waterfox, WeChat, Weibo, \nYandex, baidu, iCab, w3m, Whale Browser...\n\n# 'browser.version' determined dynamically\n```\n\n* `getDevice()`\n * returns `{ model: '', type: '', vendor: '' }`\n\n```sh\n# Possible 'device.type':\nconsole, mobile, tablet, smarttv, wearable, embedded\n\n##########\n# NOTE: 'desktop' is not a possible device type. \n# UAParser only reports info directly available from the UA string, which is not the case for 'desktop' device type.\n# If you wish to detect desktop devices, you must handle the needed logic yourself.\n# You can read more about it in this issue: https://github.com/faisalman/ua-parser-js/issues/182\n##########\n\n# Possible 'device.vendor':\nAcer, Alcatel, Amazon, Apple, Archos, ASUS, AT&T, BenQ, BlackBerry, Dell,\nEssential, Fairphone, GeeksPhone, Google, HP, HTC, Huawei, Jolla, Lenovo, LG, \nMeizu, Microsoft, Motorola, Nexian, Nintendo, Nokia, Nvidia, OnePlus, OPPO, Ouya,\nPalm, Panasonic, Pebble, Polytron, Realme, RIM, Roku, Samsung, Sharp, Siemens,\nSony[Ericsson], Sprint, Tesla, Vivo, Vodafone, Xbox, Xiaomi, Zebra, ZTE, ...\n\n# 'device.model' determined dynamically\n```\n\n* `getEngine()`\n * returns `{ name: '', version: '' }`\n\n```sh\n# Possible 'engine.name'\nAmaya, Blink, EdgeHTML, Flow, Gecko, Goanna, iCab, KHTML, Links, Lynx, NetFront,\nNetSurf, Presto, Tasman, Trident, w3m, WebKit\n\n# 'engine.version' determined dynamically\n```\n\n* `getOS()`\n * returns `{ name: '', version: '' }`\n\n```sh\n# Possible 'os.name'\nAIX, Amiga OS, Android[-x86], Arch, Bada, BeOS, BlackBerry, CentOS, Chromium OS,\nContiki, Fedora, Firefox OS, FreeBSD, Debian, Deepin, DragonFly, elementary OS, \nFuchsia, Gentoo, GhostBSD, GNU, Haiku, HarmonyOS, HP-UX, Hurd, iOS, Joli, KaiOS, \nLinpus, Linspire,Linux, Mac OS, Maemo, Mageia, Mandriva, Manjaro, MeeGo, Minix, \nMint, Morph OS, NetBSD, Nintendo, OpenBSD, OpenVMS, OS/2, Palm, PC-BSD, PCLinuxOS, \nPlan9, PlayStation, QNX, Raspbian, RedHat, RIM Tablet OS, RISC OS, Sabayon, \nSailfish, Series40, Slackware, Solaris, SUSE, Symbian, Tizen, Ubuntu, Unix, \nVectorLinux, WebOS, Windows [Phone/Mobile], Zenwalk, ...\n\n# 'os.version' determined dynamically\n```\n\n* `getCPU()`\n * returns `{ architecture: '' }`\n\n```sh\n# Possible 'cpu.architecture'\n68k, amd64, arm[64/hf], avr, ia[32/64], irix[64], mips[64], pa-risc, ppc, sparc[64]\n```\n\n* `getUA()`\n * returns UA string of current instance\n\n* `setUA(uastring)`\n * set UA string to be parsed\n * returns current instance\n\n# Usage\n\n## Using HTML\n\n```html\n\n\n\n\n\n\n\n\n\n```\n\n## Using node.js\n\nNote: Device information is not available in the NodeJS environment.\n\n```sh\n$ npm install ua-parser-js\n```\n\n```js\nvar http = require('http');\nvar parser = require('ua-parser-js');\n\nhttp.createServer(function (req, res) {\n // get user-agent header\n var ua = parser(req.headers['user-agent']);\n // write the result as response\n res.end(JSON.stringify(ua, null, ' '));\n})\n.listen(1337, '127.0.0.1');\n\nconsole.log('Server running at http://127.0.0.1:1337/');\n```\n\n## Using TypeScript\n\n```sh\n$ npm install --save @types/ua-parser-js\n# Download TS type definition from DefinitelyTyped repository:\n# https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ua-parser-js\n```\n\n## Using jQuery/Zepto ($.ua)\n\nAlthough 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)`.\n\n```js\n// 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':\n\n// Get the details\nconsole.log($.ua.device); // {vendor: \"HTC\", model: \"Evo Shift 4G\", type: \"mobile\"}\nconsole.log($.ua.os); // {name: \"Android\", version: \"2.3.4\"}\nconsole.log($.ua.os.name); // \"Android\"\nconsole.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\"\n\n// Now lets try to reset to another custom user-agent\n$.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');\n\n// Test again\nconsole.log($.ua.browser.name); // \"Safari\"\nconsole.log($.ua.engine.name); // \"Webkit\"\nconsole.log($.ua.device); // {vendor: \"Motorola\", model: \"Xoom\", type: \"tablet\"}\nconsole.log(parseInt($.ua.browser.version.split('.')[0], 10)); // 4\n\n// Add class to tag\n// \n$('body').addClass('ua-browser-' + $.ua.browser.name + ' ua-devicetype-' + $.ua.device.type);\n```\n\n## Using Extension\n\n* `UAParser([uastring,] extensions)`\n\n```js\n// Example:\nvar myOwnListOfBrowsers = [\n [/(mybrowser)\\/([\\w\\.]+)/i], [UAParser.BROWSER.NAME, UAParser.BROWSER.VERSION]\n];\nvar myParser = new UAParser({ browser: myOwnListOfBrowsers });\nvar myUA = 'Mozilla/5.0 MyBrowser/1.3';\nconsole.log(myParser.setUA(myUA).getBrowser()); // {name: \"MyBrowser\", version: \"1.3\"}\n```\n\n# Development\n\n## Sponsors\n\n\n\n\n\n## Contributors\n\n\n \n\n\nMade with [contributors-img](https://contrib.rocks).\n\n## How To Contribute\n\n* Fork and clone this repository\n* Make some changes as required\n* Write unit test to showcase its functionality\n* Run the test suites to make sure it's not breaking anything `$ npm test`\n* Submit a pull request under `develop` branch\n\n# License\n\nMIT License\n\nCopyright (c) 2012-2021 Faisal Salman <>\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.","users":{}}
![](\"https://raw.githubusercontent.com/faisalman/ua-parser-js/gh-pages/images/logo.png\"){kind=logo}
\n![](\"https://travis-ci.org/faisalman/ua-parser-js.svg?branch=master\")
\n![](\"https://img.shields.io/npm/v/ua-parser-js.svg\")
\n![](\"https://img.shields.io/npm/dw/ua-parser-js.svg\")
\n![](\"https://img.shields.io/cdnjs/v/UAParser.js.svg\")
\n![](\"https://opencollective.com/ua-parser-js/tiers/backers.svg?avatarHeight=64\")
![](\"https://opencollective.com/ua-parser-js/tiers/sponsors.svg?avatarHeight=64\")
\n\n![](\"https://cdn.rawgit.com/twolfson/paypal-github-button/1.0.0/dist/button.svg\")
\n\n## Contributors\n\n\n