ua-parser-js 0.7.37 → 0.8.0

package/readme.md

@@ -15,106 +15,40 @@
 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
+* Demo      : http://faisalman.github.io/ua-parser-js
 * Source    : https://github.com/faisalman/ua-parser-js
-* Documentation : 
-  * v1 : https://github.com/faisalman/ua-parser-js/tree/1.0.35#documentation
-  * v2 : https://faisalman.github.io/ua-parser-js-docs/v2
-
-***
-
-### From Our Sponsors:
-<table>
-<thead>
-</thead>
-<tbody>
-<tr>
-<td colspan="2">
-<a href="https://opencollective.com/ua-parser-js">↗ Become a sponsor</a>
-</td>
-</tr>
-</tbody>
-</table>
-
----
 
 # Documentation
-### UAParser([user-agent][,extensions])
-typeof `user-agent` "string".
-
-typeof `extensions` "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 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([uastring][,extensions])`
-```js
-let parser = new UAParser("user-agent"); // you need to pass the user-agent for nodejs
-console.log(parser); // {}
-let parserResults = parser.getResult();
-console.log(parserResults);
-/** {
-  "ua": "",
-  "browser": {},
-  "engine": {},
-  "os": {},
-  "device": {},
-  "cpu": {}
-} */
-```
+    * returns new instance
 
-When you call UAParser without the `new` keyword, it will automatically call `getResult()` function and return the parsed results.
 * `UAParser([uastring][,extensions])`
     * 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: '' }`
 
 ```sh
 # Possible 'browser.name':
-2345Explorer, 360 Browser, Alipay, Amaya, Android Browser, Arora, Avant, Avast, 
-AVG, Baidu, Basilisk, Blazer, Bolt, Brave, Bowser, Camino, Chimera,
-Chrome Headless, Chrome WebView, Chrome, Chromium, Cobalt, Comodo Dragon, Dillo,
-Dolphin, Doris, DuckDuckGo, Edge, Electron, Epiphany, Facebook, Falkon, Fennec, 
-Firebird, Firefox [Focus/Reality], Flock, Flow, GSA, GoBrowser, Heytap, 
-Huawei Browser, iCab, ICE Browser, IE, IEMobile, IceApe, IceCat, IceDragon, 
-Iceweasel, Instagram, Iridium, Iron, Jasmine, Kakao[Story/Talk], K-Meleon, 
-Kindle, Klar, Klarna, Konqueror, LBBROWSER, Line, LinkedIn, Links, Lunascape, 
-Lynx, MIUI Browser, Maemo, Maxthon, 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 Internet, SeaMonkey, Silk, 
-Skyfire, Sleipnir, Slim, SlimBrowser, Smart Lenovo Browser, Snapchat, 
-Sogou [Explorer/Mobile], Swiftfox, Tesla, TikTok, Tizen Browser, UCBrowser, 
-UP.Browser, Viera, Vivaldi, Vivo Browser, Waterfox, WeChat, Weibo, Yandex, w3m, 
-Whale Browser, ...
+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, Edge, Electron, Epiphany, Facebook, Falkon, Fennec, Firebird,
+Firefox [Reality], Flock, Flow, GSA, GoBrowser, ICE Browser, IE, IEMobile, IceApe, 
+IceCat, IceDragon, Iceweasel, Instagram, Iridium, Iron, Jasmine, K-Meleon,
+Kindle, Konqueror, LBBROWSER, Line, Links, Lunascape, Lynx, MIUI Browser,
+Maemo Browser, Maemo, Maxthon, MetaSr Midori, Minimo, Mobile Safari, Mosaic,
+Mozilla, NetFront, NetSurf, Netfront, Netscape, NokiaBrowser, 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, Vivaldi, Waterfox, WeChat,
+Weibo, Yandex, baidu, iCab, w3m, Whale Browser...
 
 # 'browser.version' determined dynamically
 ```
@@ -126,20 +60,12 @@ Whale Browser, ...
 # 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, Facebook, Fairphone, GeeksPhone, Google, HP, HTC, Huawei, Infinix, 
-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, Tecno, Tesla, Ulefone, 
-Vivo, Vodafone, Xbox, Xiaomi, Zebra, ZTE, ...
+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, Samsung, Sharp, Siemens,
+Sony[Ericsson], Sprint, Tesla, Vivo, Vodafone, Xbox, Xiaomi, Zebra, ZTE, ...
 
 # 'device.model' determined dynamically
 ```
@@ -149,8 +75,8 @@ Vivo, Vodafone, Xbox, Xiaomi, Zebra, ZTE, ...
 
 ```sh
 # Possible 'engine.name'
-Amaya, Blink, EdgeHTML, Flow, Gecko, Goanna, iCab, KHTML, LibWeb, Links, Lynx, 
-NetFront, NetSurf, Presto, Tasman, Trident, w3m, WebKit
+Amaya, Blink, EdgeHTML, Flow, Gecko, Goanna, iCab, KHTML, Links, Lynx, NetFront,
+NetSurf, Presto, Tasman, Trident, w3m, WebKit
 
 # 'engine.version' determined dynamically
 ```
@@ -160,15 +86,13 @@ NetFront, NetSurf, Presto, Tasman, Trident, w3m, WebKit
 
 ```sh
 # 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, 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, ...
+AIX, Amiga OS, Android, Arch, Bada, BeOS, BlackBerry, CentOS, Chromium OS,
+Contiki, Fedora, Firefox OS, FreeBSD, Debian, DragonFly, Fuchsia, Gentoo, GNU,
+Haiku, Hurd, iOS, Joli, KaiOS, Linpus, Linux, Mac OS, Mageia, Mandriva, 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,
+Sailfish, Series40, Slackware, Solaris, SUSE, Symbian, Tizen, Ubuntu, Unix, 
+VectorLinux, WebOS, Windows [Phone/Mobile], Zenwalk, ...
 
 # 'os.version' determined dynamically
 ```
@@ -178,10 +102,12 @@ Windows [Phone/Mobile], Zenwalk, ...
 
 ```sh
 # Possible 'cpu.architecture'
-68k, amd64, arm[64/hf], avr, ia[32/64], irix[64], mips[64], pa-risc, ppc, 
-sparc[64]
+68k, amd64, arm[64/hf], avr, ia[32/64], irix[64], mips[64], pa-risc, ppc, sparc[64]
 ```
 
+* `getResult()`
+    * returns `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`
+
 * `getUA()`
     * returns UA string of current instance
 
@@ -265,8 +191,6 @@ sparc[64]
 
 ## Using node.js
 
-Note: Device information is not available in the NodeJS environment.
-
 ```sh
 $ npm install ua-parser-js
 ```
@@ -337,10 +261,9 @@ console.log(myParser.setUA(myUA).getBrowser());  // {name: "MyBrowser", version:
 
 # Development
 
-## Backers & Sponsors
+## Sponsors
 
-<a href="https://opencollective.com/ua-parser-js"><img src="https://opencollective.com/ua-parser-js/organizations.svg?avatarHeight=64"></a>
-<a href="https://opencollective.com/ua-parser-js"><img src="https://opencollective.com/ua-parser-js/individuals.svg?avatarHeight=64"></a>
+<a href="https://opencollective.com/ua-parser-js"><img src="https://opencollective.com/ua-parser-js/tiers/backers.svg?avatarHeight=64" height="80"/></a> <a href="https://opencollective.com/ua-parser-js"><img src="https://opencollective.com/ua-parser-js/tiers/sponsors.svg?avatarHeight=64" height="80"/></a>
 
 <a href="https://www.paypal.me/faisalman/"><img src="https://cdn.rawgit.com/twolfson/paypal-github-button/1.0.0/dist/button.svg" height="40"></a>