ua-parser-js 1.0.37 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (205) hide show
  1. package/LICENSE.md +616 -0
  2. package/README.md +251 -0
  3. package/dist/icons/color/LICENSE.md +3 -0
  4. package/dist/icons/color/browser/android-browser.svg +1 -0
  5. package/dist/icons/color/browser/avant.png +0 -0
  6. package/dist/icons/color/browser/basilisk.png +0 -0
  7. package/dist/icons/color/browser/basilisk.svg +1 -0
  8. package/dist/icons/color/browser/brave.png +0 -0
  9. package/dist/icons/color/browser/brave.svg +1 -0
  10. package/dist/icons/color/browser/chrome.png +0 -0
  11. package/dist/icons/color/browser/chrome.svg +1 -0
  12. package/dist/icons/color/browser/chromium.png +0 -0
  13. package/dist/icons/color/browser/chromium.svg +1 -0
  14. package/dist/icons/color/browser/coc-coc.png +0 -0
  15. package/dist/icons/color/browser/default.png +0 -0
  16. package/dist/icons/color/browser/default.svg +1 -0
  17. package/dist/icons/color/browser/dolphin.png +0 -0
  18. package/dist/icons/color/browser/edge.png +0 -0
  19. package/dist/icons/color/browser/edge.svg +1 -0
  20. package/dist/icons/color/browser/electron.png +0 -0
  21. package/dist/icons/color/browser/electron.svg +1 -0
  22. package/dist/icons/color/browser/falkon.png +0 -0
  23. package/dist/icons/color/browser/falkon.svg +1 -0
  24. package/dist/icons/color/browser/firefox-reality.png +0 -0
  25. package/dist/icons/color/browser/firefox-reality.svg +1 -0
  26. package/dist/icons/color/browser/firefox.png +0 -0
  27. package/dist/icons/color/browser/firefox.svg +1 -0
  28. package/dist/icons/color/browser/gsa.svg +9 -0
  29. package/dist/icons/color/browser/icecat.png +0 -0
  30. package/dist/icons/color/browser/ie.svg +6 -0
  31. package/dist/icons/color/browser/konqueror.png +0 -0
  32. package/dist/icons/color/browser/konqueror.svg +1 -0
  33. package/dist/icons/color/browser/maxthon.png +0 -0
  34. package/dist/icons/color/browser/midori.png +0 -0
  35. package/dist/icons/color/browser/midori.svg +1 -0
  36. package/dist/icons/color/browser/netsurf.png +0 -0
  37. package/dist/icons/color/browser/netsurf.svg +1 -0
  38. package/dist/icons/color/browser/opera-gx.png +0 -0
  39. package/dist/icons/color/browser/opera-gx.svg +1 -0
  40. package/dist/icons/color/browser/opera-mini.png +0 -0
  41. package/dist/icons/color/browser/opera-touch.png +0 -0
  42. package/dist/icons/color/browser/opera.png +0 -0
  43. package/dist/icons/color/browser/opera.svg +1 -0
  44. package/dist/icons/color/browser/palemoon.png +0 -0
  45. package/dist/icons/color/browser/puffin.png +0 -0
  46. package/dist/icons/color/browser/safari.png +0 -0
  47. package/dist/icons/color/browser/safari.svg +1 -0
  48. package/dist/icons/color/browser/samsung-internet.png +0 -0
  49. package/dist/icons/color/browser/samsung-internet.svg +1 -0
  50. package/dist/icons/color/browser/seamonkey.png +0 -0
  51. package/dist/icons/color/browser/silk.png +0 -0
  52. package/dist/icons/color/browser/sogou-mobile.png +0 -0
  53. package/dist/icons/color/browser/ucbrowser.png +0 -0
  54. package/dist/icons/color/browser/ucbrowser.svg +1 -0
  55. package/dist/icons/color/browser/vivaldi.png +0 -0
  56. package/dist/icons/color/browser/vivaldi.svg +1 -0
  57. package/dist/icons/color/browser/webkit.png +0 -0
  58. package/dist/icons/color/browser/webkit.svg +1 -0
  59. package/dist/icons/color/browser/yandex.png +0 -0
  60. package/dist/icons/color/os/centos.svg +1 -0
  61. package/dist/icons/mono/LICENSE.md +3 -0
  62. package/dist/icons/mono/browser/alipay.svg +1 -0
  63. package/dist/icons/mono/browser/android-browser.svg +1 -0
  64. package/dist/icons/mono/browser/avast-secure-browser.svg +1 -0
  65. package/dist/icons/mono/browser/baidu-browser.svg +1 -0
  66. package/dist/icons/mono/browser/brave.svg +1 -0
  67. package/dist/icons/mono/browser/chrome-headless.svg +1 -0
  68. package/dist/icons/mono/browser/chrome-webview.svg +1 -0
  69. package/dist/icons/mono/browser/chrome.svg +1 -0
  70. package/dist/icons/mono/browser/chromium.svg +1 -0
  71. package/dist/icons/mono/browser/duckduckgo.svg +1 -0
  72. package/dist/icons/mono/browser/edge.svg +1 -0
  73. package/dist/icons/mono/browser/electron.svg +1 -0
  74. package/dist/icons/mono/browser/facebook.svg +1 -0
  75. package/dist/icons/mono/browser/firefox-focus.svg +1 -0
  76. package/dist/icons/mono/browser/firefox-reality.svg +1 -0
  77. package/dist/icons/mono/browser/firefox.svg +1 -0
  78. package/dist/icons/mono/browser/gsa.svg +1 -0
  79. package/dist/icons/mono/browser/huawei-browser.svg +1 -0
  80. package/dist/icons/mono/browser/icecat.svg +1 -0
  81. package/dist/icons/mono/browser/ie.svg +1 -0
  82. package/dist/icons/mono/browser/instagram.svg +1 -0
  83. package/dist/icons/mono/browser/jasmine.svg +1 -0
  84. package/dist/icons/mono/browser/kakaotalk.svg +1 -0
  85. package/dist/icons/mono/browser/klarna.svg +1 -0
  86. package/dist/icons/mono/browser/line.svg +1 -0
  87. package/dist/icons/mono/browser/linkedin.svg +1 -0
  88. package/dist/icons/mono/browser/miui-browser.svg +1 -0
  89. package/dist/icons/mono/browser/mobile-chrome.svg +1 -0
  90. package/dist/icons/mono/browser/mobile-firefox.svg +1 -0
  91. package/dist/icons/mono/browser/mobile-safari.svg +1 -0
  92. package/dist/icons/mono/browser/mozilla.svg +1 -0
  93. package/dist/icons/mono/browser/naver.svg +1 -0
  94. package/dist/icons/mono/browser/nokia-browser.svg +1 -0
  95. package/dist/icons/mono/browser/oculus-browser.svg +1 -0
  96. package/dist/icons/mono/browser/opera-coast.svg +1 -0
  97. package/dist/icons/mono/browser/opera-gx.svg +1 -0
  98. package/dist/icons/mono/browser/opera-mini.svg +1 -0
  99. package/dist/icons/mono/browser/opera-mobi.svg +1 -0
  100. package/dist/icons/mono/browser/opera-tablet.svg +1 -0
  101. package/dist/icons/mono/browser/opera-touch.svg +1 -0
  102. package/dist/icons/mono/browser/opera.svg +1 -0
  103. package/dist/icons/mono/browser/qqbrowser.svg +1 -0
  104. package/dist/icons/mono/browser/qqbrowserlite.svg +1 -0
  105. package/dist/icons/mono/browser/safari.svg +1 -0
  106. package/dist/icons/mono/browser/sailfish-browser.svg +1 -0
  107. package/dist/icons/mono/browser/samsung-internet.svg +1 -0
  108. package/dist/icons/mono/browser/smart-lenovo-browser.svg +1 -0
  109. package/dist/icons/mono/browser/snapchat.svg +1 -0
  110. package/dist/icons/mono/browser/sogou-explorer.svg +1 -0
  111. package/dist/icons/mono/browser/sogou-mobile.svg +1 -0
  112. package/dist/icons/mono/browser/tesla.svg +1 -0
  113. package/dist/icons/mono/browser/tiktok.svg +1 -0
  114. package/dist/icons/mono/browser/twitter.svg +1 -0
  115. package/dist/icons/mono/browser/vivaldi.svg +1 -0
  116. package/dist/icons/mono/browser/vivo-browser.svg +1 -0
  117. package/dist/icons/mono/browser/wechat.svg +1 -0
  118. package/dist/icons/mono/browser/weibo.svg +1 -0
  119. package/dist/icons/mono/browser/yandex.svg +1 -0
  120. package/dist/icons/mono/device/acer.svg +1 -0
  121. package/dist/icons/mono/device/amazon.svg +1 -0
  122. package/dist/icons/mono/device/apple.svg +1 -0
  123. package/dist/icons/mono/device/asus.svg +1 -0
  124. package/dist/icons/mono/device/att.svg +1 -0
  125. package/dist/icons/mono/device/blackberry.svg +1 -0
  126. package/dist/icons/mono/device/dell.svg +1 -0
  127. package/dist/icons/mono/device/facebook.svg +1 -0
  128. package/dist/icons/mono/device/fairphone.svg +1 -0
  129. package/dist/icons/mono/device/google.svg +1 -0
  130. package/dist/icons/mono/device/hp.svg +1 -0
  131. package/dist/icons/mono/device/huawei.svg +1 -0
  132. package/dist/icons/mono/device/lenovo.svg +1 -0
  133. package/dist/icons/mono/device/lg.svg +1 -0
  134. package/dist/icons/mono/device/meizu.svg +1 -0
  135. package/dist/icons/mono/device/microsoft.svg +1 -0
  136. package/dist/icons/mono/device/motorola.svg +1 -0
  137. package/dist/icons/mono/device/nintendo.svg +1 -0
  138. package/dist/icons/mono/device/nokia.svg +1 -0
  139. package/dist/icons/mono/device/nvidia.svg +1 -0
  140. package/dist/icons/mono/device/oneplus.svg +1 -0
  141. package/dist/icons/mono/device/oppo.svg +1 -0
  142. package/dist/icons/mono/device/panasonic.svg +1 -0
  143. package/dist/icons/mono/device/roku.svg +1 -0
  144. package/dist/icons/mono/device/samsung.svg +1 -0
  145. package/dist/icons/mono/device/siemens.svg +1 -0
  146. package/dist/icons/mono/device/sony.svg +1 -0
  147. package/dist/icons/mono/device/tesla.svg +1 -0
  148. package/dist/icons/mono/device/vivo.svg +1 -0
  149. package/dist/icons/mono/device/vodafone.svg +1 -0
  150. package/dist/icons/mono/device/xiaomi.svg +1 -0
  151. package/dist/icons/mono/device/zebra.svg +1 -0
  152. package/dist/icons/mono/os/android.svg +1 -0
  153. package/dist/icons/mono/os/arch.svg +1 -0
  154. package/dist/icons/mono/os/blackberry.svg +1 -0
  155. package/dist/icons/mono/os/centos.svg +1 -0
  156. package/dist/icons/mono/os/chrome-os.svg +1 -0
  157. package/dist/icons/mono/os/chromecast.svg +1 -0
  158. package/dist/icons/mono/os/debian.svg +1 -0
  159. package/dist/icons/mono/os/deepin.svg +1 -0
  160. package/dist/icons/mono/os/elementary-os.svg +1 -0
  161. package/dist/icons/mono/os/fedora.svg +1 -0
  162. package/dist/icons/mono/os/firefox.svg +1 -0
  163. package/dist/icons/mono/os/freebsd.svg +1 -0
  164. package/dist/icons/mono/os/gentoo.svg +1 -0
  165. package/dist/icons/mono/os/gnu.svg +1 -0
  166. package/dist/icons/mono/os/harmonyos.svg +1 -0
  167. package/dist/icons/mono/os/ios.svg +1 -0
  168. package/dist/icons/mono/os/kaios.svg +1 -0
  169. package/dist/icons/mono/os/linux.svg +1 -0
  170. package/dist/icons/mono/os/macos.svg +1 -0
  171. package/dist/icons/mono/os/manjaro.svg +1 -0
  172. package/dist/icons/mono/os/mint.svg +1 -0
  173. package/dist/icons/mono/os/netbsd.svg +1 -0
  174. package/dist/icons/mono/os/nintendo.svg +1 -0
  175. package/dist/icons/mono/os/openbsd.svg +1 -0
  176. package/dist/icons/mono/os/playstation.svg +1 -0
  177. package/dist/icons/mono/os/raspbian.svg +1 -0
  178. package/dist/icons/mono/os/redhat.svg +1 -0
  179. package/dist/icons/mono/os/sailfish.svg +1 -0
  180. package/dist/icons/mono/os/slackware.svg +1 -0
  181. package/dist/icons/mono/os/suse.svg +1 -0
  182. package/dist/icons/mono/os/ubuntu.svg +1 -0
  183. package/dist/icons/mono/os/windows.svg +1 -0
  184. package/dist/icons/mono/os/xbox.svg +1 -0
  185. package/dist/ua-parser.min.js +4 -4
  186. package/dist/ua-parser.min.mjs +4 -0
  187. package/dist/ua-parser.pack.js +4 -4
  188. package/dist/ua-parser.pack.mjs +4 -0
  189. package/package.json +86 -36
  190. package/script/cli.js +4 -0
  191. package/src/enums/ua-parser-enums.d.ts +366 -0
  192. package/src/enums/ua-parser-enums.js +393 -0
  193. package/src/enums/ua-parser-enums.mjs +397 -0
  194. package/src/extensions/ua-parser-extensions.d.ts +16 -0
  195. package/src/extensions/ua-parser-extensions.js +366 -0
  196. package/src/extensions/ua-parser-extensions.mjs +370 -0
  197. package/src/helpers/ua-parser-helpers.d.ts +27 -0
  198. package/src/helpers/ua-parser-helpers.js +137 -0
  199. package/src/helpers/ua-parser-helpers.mjs +141 -0
  200. package/src/main/ua-parser.d.ts +113 -0
  201. package/src/main/ua-parser.js +1439 -0
  202. package/src/main/ua-parser.mjs +1397 -0
  203. package/license.md +0 -21
  204. package/readme.md +0 -385
  205. package/src/ua-parser.js +0 -946
package/license.md DELETED
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2012-2023 Faisal Salman <<f@faisalman.com>>
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
package/readme.md DELETED
@@ -1,385 +0,0 @@
1
- <p align="center">
2
- <img src="https://raw.githubusercontent.com/faisalman/ua-parser-js/gh-pages/images/logo.png" width="256" height="256">
3
- </p>
4
-
5
- <p align="center">
6
- <a href="https://travis-ci.org/faisalman/ua-parser-js"><img src="https://travis-ci.org/faisalman/ua-parser-js.svg?branch=master"></a>
7
- <a href="https://www.npmjs.com/package/ua-parser-js"><img src="https://img.shields.io/npm/v/ua-parser-js.svg"></a>
8
- <a href="https://www.npmjs.com/package/ua-parser-js"><img src="https://img.shields.io/npm/dw/ua-parser-js.svg"></a>
9
- <a href="https://www.jsdelivr.com/package/npm/ua-parser-js"><img src="https://data.jsdelivr.com/v1/package/npm/ua-parser-js/badge"></a>
10
- <a href="https://cdnjs.com/libraries/UAParser.js"><img src="https://img.shields.io/cdnjs/v/UAParser.js.svg"></a>
11
- </p>
12
-
13
- # UAParser.js
14
-
15
- 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).
16
-
17
- * Author : Faisal Salman <<f@faisalman.com>>
18
- * Demo : https://faisalman.github.io/ua-parser-js
19
- * Source : https://github.com/faisalman/ua-parser-js
20
- * Documentation :
21
- * v1 : https://github.com/faisalman/ua-parser-js/tree/1.0.35#documentation
22
- * v2 : https://faisalman.github.io/ua-parser-js-docs/v2
23
-
24
- ***
25
-
26
- ### From Our Sponsors:
27
- <table>
28
- <thead>
29
- </thead>
30
- <tbody>
31
- <tr>
32
- <td colspan="2">
33
- <a href="https://opencollective.com/ua-parser-js">↗ Become a sponsor</a>
34
- </td>
35
- </tr>
36
- </tbody>
37
- </table>
38
-
39
- ---
40
-
41
- # Documentation
42
- ### UAParser([user-agent][,extensions])
43
- typeof `user-agent` "string".
44
-
45
- typeof `extensions` "array".
46
-
47
- 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.
48
- Usually you can find the user agent in:
49
- `request.headers["user-agent"]`.
50
-
51
-
52
- ## Constructor
53
- 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.
54
- Like so:
55
- * `new UAParser([uastring][,extensions])`
56
- ```js
57
- let parser = new UAParser("user-agent"); // you need to pass the user-agent for nodejs
58
- console.log(parser); // {}
59
- let parserResults = parser.getResult();
60
- console.log(parserResults);
61
- /** {
62
- "ua": "",
63
- "browser": {},
64
- "engine": {},
65
- "os": {},
66
- "device": {},
67
- "cpu": {}
68
- } */
69
- ```
70
-
71
- When you call UAParser without the `new` keyword, it will automatically call `getResult()` function and return the parsed results.
72
- * `UAParser([uastring][,extensions])`
73
- * returns result object `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`
74
-
75
- ## Methods
76
-
77
- #### Methods table
78
- The methods are self explanatory, here's a small overview on all the available methods:
79
- * `getResult()` - returns all function object calls, user-agent string, browser info, cpu, device, engine, os:
80
- `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`.
81
-
82
- * `getBrowser()` - returns the browser name and version.
83
- * `getDevice()` - returns the device model, type, vendor.
84
- * `getEngine()` - returns the current browser engine name and version.
85
- * `getOS()` - returns the running operating system name and version.
86
- * `getCPU()` - returns CPU architectural design name.
87
- * `getUA()` - returns the user-agent string.
88
- * `setUA(user-agent)` - set a custom user-agent to be parsed.
89
-
90
-
91
- ---
92
-
93
- * `getResult()`
94
- * returns `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`
95
-
96
- * `getBrowser()`
97
- * returns `{ name: '', version: '' }`
98
-
99
- ```sh
100
- # Possible 'browser.name':
101
- 2345Explorer, 360 Browser, Alipay, Amaya, Android Browser, Arora, Avant, Avast,
102
- AVG, Baidu, Basilisk, Blazer, Bolt, Brave, Bowser, Camino, Chimera,
103
- Chrome Headless, Chrome WebView, Chrome, Chromium, Cobalt, Comodo Dragon, Dillo,
104
- Dolphin, Doris, DuckDuckGo, Edge, Electron, Epiphany, Facebook, Falkon, Fennec,
105
- Firebird, Firefox [Focus/Reality], Flock, Flow, GSA, GoBrowser, Heytap,
106
- Huawei Browser, iCab, ICE Browser, IE, IEMobile, IceApe, IceCat, IceDragon,
107
- Iceweasel, Instagram, Iridium, Iron, Jasmine, Kakao[Story/Talk], K-Meleon,
108
- Kindle, Klar, Klarna, Konqueror, LBBROWSER, Line, LinkedIn, Links, Lunascape,
109
- Lynx, MIUI Browser, Maemo, Maxthon, Midori, Minimo, Mobile Safari, Mosaic,
110
- Mozilla, NetFront, NetSurf, Netfront, Netscape, NokiaBrowser, Obigo,
111
- Oculus Browser, OmniWeb, Opera Coast, Opera [Mini/Mobi/Tablet], PaleMoon,
112
- PhantomJS, Phoenix, Polaris, Puffin, QQ, QQBrowser, QQBrowserLite, Quark,
113
- QupZilla, RockMelt, Safari, Sailfish Browser, Samsung Internet, SeaMonkey, Silk,
114
- Skyfire, Sleipnir, Slim, SlimBrowser, Smart Lenovo Browser, Snapchat,
115
- Sogou [Explorer/Mobile], Swiftfox, Tesla, TikTok, Tizen Browser, UCBrowser,
116
- UP.Browser, Viera, Vivaldi, Vivo Browser, Waterfox, WeChat, Weibo, Yandex, w3m,
117
- Whale Browser, ...
118
-
119
- # 'browser.version' determined dynamically
120
- ```
121
-
122
- * `getDevice()`
123
- * returns `{ model: '', type: '', vendor: '' }`
124
-
125
- ```sh
126
- # Possible 'device.type':
127
- console, mobile, tablet, smarttv, wearable, embedded
128
-
129
- ##########
130
- # NOTE: 'desktop' is not a possible device type.
131
- # UAParser only reports info directly available from the UA string, which is not the case for 'desktop' device type.
132
- # If you wish to detect desktop devices, you must handle the needed logic yourself.
133
- # You can read more about it in this issue: https://github.com/faisalman/ua-parser-js/issues/182
134
- ##########
135
-
136
- # Possible 'device.vendor':
137
- Acer, Alcatel, Amazon, Apple, Archos, ASUS, AT&T, BenQ, BlackBerry, Dell,
138
- Essential, Facebook, Fairphone, GeeksPhone, Google, HP, HTC, Huawei, Infinix,
139
- Jolla, Kobo, Lenovo, LG, Meizu, Microsoft, Motorola, Nexian, Nintendo, Nokia,
140
- Nvidia, OnePlus, OPPO, Ouya, Palm, Panasonic, Pebble, Polytron, Realme, RIM,
141
- Roku, Samsung, Sharp, Siemens, Sony[Ericsson], Sprint, Tecno, Tesla, Ulefone,
142
- Vivo, Vodafone, Xbox, Xiaomi, Zebra, ZTE, ...
143
-
144
- # 'device.model' determined dynamically
145
- ```
146
-
147
- * `getEngine()`
148
- * returns `{ name: '', version: '' }`
149
-
150
- ```sh
151
- # Possible 'engine.name'
152
- Amaya, Blink, EdgeHTML, Flow, Gecko, Goanna, iCab, KHTML, LibWeb, Links, Lynx,
153
- NetFront, NetSurf, Presto, Tasman, Trident, w3m, WebKit
154
-
155
- # 'engine.version' determined dynamically
156
- ```
157
-
158
- * `getOS()`
159
- * returns `{ name: '', version: '' }`
160
-
161
- ```sh
162
- # Possible 'os.name'
163
- AIX, Amiga OS, Android[-x86], Arch, Bada, BeOS, BlackBerry, CentOS, Chromium OS,
164
- Contiki, Fedora, Firefox OS, FreeBSD, Debian, Deepin, DragonFly, elementary OS,
165
- Fuchsia, Gentoo, GhostBSD, GNU, Haiku, HarmonyOS, HP-UX, Hurd, iOS, Joli, KaiOS,
166
- Linpus, Linspire,Linux, Mac OS, Maemo, Mageia, Mandriva, Manjaro, MeeGo, Minix,
167
- Mint, Morph OS, NetBSD, NetRange, NetTV, Nintendo, OpenBSD, OpenVMS, OS/2, Palm,
168
- PC-BSD, PCLinuxOS, Plan9, PlayStation, QNX, Raspbian, RedHat, RIM Tablet OS,
169
- RISC OS, Sabayon, Sailfish, SerenityOS, Series40, Slackware, Solaris, SUSE,
170
- Symbian, Tizen, Ubuntu, Unix, VectorLinux, Viera, watchOS, WebOS,
171
- Windows [Phone/Mobile], Zenwalk, ...
172
-
173
- # 'os.version' determined dynamically
174
- ```
175
-
176
- * `getCPU()`
177
- * returns `{ architecture: '' }`
178
-
179
- ```sh
180
- # Possible 'cpu.architecture'
181
- 68k, amd64, arm[64/hf], avr, ia[32/64], irix[64], mips[64], pa-risc, ppc,
182
- sparc[64]
183
- ```
184
-
185
- * `getUA()`
186
- * returns UA string of current instance
187
-
188
- * `setUA(uastring)`
189
- * set UA string to be parsed
190
- * returns current instance
191
-
192
- # Usage
193
-
194
- ## Using HTML
195
-
196
- ```html
197
- <!doctype html>
198
- <html>
199
- <head>
200
- <script src="ua-parser.min.js"></script>
201
- <script>
202
-
203
- var parser = new UAParser();
204
- console.log(parser.getResult());
205
- /*
206
- /// This will print an object structured like this:
207
- {
208
- ua: "",
209
- browser: {
210
- name: "",
211
- version: "",
212
- major: "" //@deprecated
213
- },
214
- engine: {
215
- name: "",
216
- version: ""
217
- },
218
- os: {
219
- name: "",
220
- version: ""
221
- },
222
- device: {
223
- model: "",
224
- type: "",
225
- vendor: ""
226
- },
227
- cpu: {
228
- architecture: ""
229
- }
230
- }
231
- */
232
- // Default result depends on current window.navigator.userAgent value
233
-
234
- // Now let's try a custom user-agent string as an example
235
- 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";
236
- parser.setUA(uastring1);
237
- var result = parser.getResult();
238
- // You can also use UAParser constructor directly without having to create an instance:
239
- // var result = UAParser(uastring1);
240
-
241
- console.log(result.browser); // {name: "Chromium", version: "15.0.874.106"}
242
- console.log(result.device); // {model: undefined, type: undefined, vendor: undefined}
243
- console.log(result.os); // {name: "Ubuntu", version: "11.10"}
244
- console.log(result.os.version); // "11.10"
245
- console.log(result.engine.name); // "WebKit"
246
- console.log(result.cpu.architecture); // "amd64"
247
-
248
- // Do some other tests
249
- var uastring2 = "Mozilla/5.0 (compatible; Konqueror/4.1; OpenBSD) KHTML/4.1.4 (like Gecko)";
250
- console.log(parser.setUA(uastring2).getBrowser().name); // "Konqueror"
251
- console.log(parser.getOS()); // {name: "OpenBSD", version: undefined}
252
- console.log(parser.getEngine()); // {name: "KHTML", version: "4.1.4"}
253
-
254
- 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';
255
- console.log(parser.setUA(uastring3).getDevice().model); // "PlayBook"
256
- console.log(parser.getOS()) // {name: "RIM Tablet OS", version: "1.0.0"}
257
- console.log(parser.getBrowser().name); // "Safari"
258
-
259
- </script>
260
- </head>
261
- <body>
262
- </body>
263
- </html>
264
- ```
265
-
266
- ## Using node.js
267
-
268
- Note: Device information is not available in the NodeJS environment.
269
-
270
- ```sh
271
- $ npm install ua-parser-js
272
- ```
273
-
274
- ```js
275
- var http = require('http');
276
- var parser = require('ua-parser-js');
277
-
278
- http.createServer(function (req, res) {
279
- // get user-agent header
280
- var ua = parser(req.headers['user-agent']);
281
- // write the result as response
282
- res.end(JSON.stringify(ua, null, ' '));
283
- })
284
- .listen(1337, '127.0.0.1');
285
-
286
- console.log('Server running at http://127.0.0.1:1337/');
287
- ```
288
-
289
- ## Using TypeScript
290
-
291
- ```sh
292
- $ npm install --save @types/ua-parser-js
293
- # Download TS type definition from DefinitelyTyped repository:
294
- # https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ua-parser-js
295
- ```
296
-
297
- ## Using jQuery/Zepto ($.ua)
298
-
299
- 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)`.
300
-
301
- ```js
302
- // 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':
303
-
304
- // Get the details
305
- console.log($.ua.device); // {vendor: "HTC", model: "Evo Shift 4G", type: "mobile"}
306
- console.log($.ua.os); // {name: "Android", version: "2.3.4"}
307
- console.log($.ua.os.name); // "Android"
308
- 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"
309
-
310
- // Now lets try to reset to another custom user-agent
311
- $.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');
312
-
313
- // Test again
314
- console.log($.ua.browser.name); // "Safari"
315
- console.log($.ua.engine.name); // "Webkit"
316
- console.log($.ua.device); // {vendor: "Motorola", model: "Xoom", type: "tablet"}
317
- console.log(parseInt($.ua.browser.version.split('.')[0], 10)); // 4
318
-
319
- // Add class to <body> tag
320
- // <body class="ua-browser-safari ua-devicetype-tablet">
321
- $('body').addClass('ua-browser-' + $.ua.browser.name + ' ua-devicetype-' + $.ua.device.type);
322
- ```
323
-
324
- ## Using Extension
325
-
326
- * `UAParser([uastring,] extensions)`
327
-
328
- ```js
329
- // Example:
330
- var myOwnListOfBrowsers = [
331
- [/(mybrowser)\/([\w\.]+)/i], [UAParser.BROWSER.NAME, UAParser.BROWSER.VERSION]
332
- ];
333
- var myParser = new UAParser({ browser: myOwnListOfBrowsers });
334
- var myUA = 'Mozilla/5.0 MyBrowser/1.3';
335
- console.log(myParser.setUA(myUA).getBrowser()); // {name: "MyBrowser", version: "1.3"}
336
- ```
337
-
338
- # Development
339
-
340
- ## Backers & Sponsors
341
-
342
- <a href="https://opencollective.com/ua-parser-js"><img src="https://opencollective.com/ua-parser-js/organizations.svg?avatarHeight=64"></a>
343
- <a href="https://opencollective.com/ua-parser-js"><img src="https://opencollective.com/ua-parser-js/individuals.svg?avatarHeight=64"></a>
344
-
345
- <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>
346
-
347
- ## Contributors
348
-
349
- <a href="https://github.com/faisalman/ua-parser-js/graphs/contributors">
350
- <img src="https://contrib.rocks/image?repo=faisalman/ua-parser-js" />
351
- </a>
352
-
353
- Made with [contributors-img](https://contrib.rocks).
354
-
355
- ## How To Contribute
356
-
357
- * Fork and clone this repository
358
- * Make some changes as required
359
- * Write unit test to showcase its functionality
360
- * Run the test suites to make sure it's not breaking anything `$ npm test`
361
- * Submit a pull request under `develop` branch
362
-
363
- # License
364
-
365
- MIT License
366
-
367
- Copyright (c) 2012-2021 Faisal Salman <<f@faisalman.com>>
368
-
369
- Permission is hereby granted, free of charge, to any person obtaining a copy
370
- of this software and associated documentation files (the "Software"), to deal
371
- in the Software without restriction, including without limitation the rights
372
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
373
- copies of the Software, and to permit persons to whom the Software is
374
- furnished to do so, subject to the following conditions:
375
-
376
- The above copyright notice and this permission notice shall be included in all
377
- copies or substantial portions of the Software.
378
-
379
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
380
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
381
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
382
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
383
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
384
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
385
- SOFTWARE.