source: trip-planner-front/node_modules/ua-parser-js/readme.md@ fa375fe

Last change on this file since fa375fe was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 11.5 KB
Line 
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
15JavaScript 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 : http://faisalman.github.io/ua-parser-js
19* Source : https://github.com/faisalman/ua-parser-js
20
21# Documentation
22
23## Constructor
24
25* `new UAParser([uastring][,extensions])`
26 * returns new instance
27
28* `UAParser([uastring][,extensions])`
29 * returns result object `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`
30
31## Methods
32
33* `getBrowser()`
34 * returns `{ name: '', version: '' }`
35
36```sh
37# Possible 'browser.name':
382345Explorer, 360 Browser, Amaya, Android Browser, Arora, Avant, Avast, AVG,
39BIDUBrowser, Baidu, Basilisk, Blazer, Bolt, Brave, Bowser, Camino, Chimera,
40Chrome Headless, Chrome WebView, Chrome, Chromium, Comodo Dragon, Dillo,
41Dolphin, Doris, Edge, Electron, Epiphany, Facebook, Falkon, Fennec, Firebird,
42Firefox [Reality], Flock, Flow, GSA, GoBrowser, ICE Browser, IE, IEMobile, IceApe,
43IceCat, IceDragon, Iceweasel, Instagram, Iridium, Iron, Jasmine, K-Meleon,
44Kindle, Konqueror, LBBROWSER, Line, Links, Lunascape, Lynx, MIUI Browser,
45Maemo Browser, Maemo, Maxthon, MetaSr Midori, Minimo, Mobile Safari, Mosaic,
46Mozilla, NetFront, NetSurf, Netfront, Netscape, NokiaBrowser, Oculus Browser,
47OmniWeb, Opera Coast, Opera [Mini/Mobi/Tablet], PaleMoon, PhantomJS, Phoenix,
48Polaris, Puffin, QQ, QQBrowser, QQBrowserLite, Quark, QupZilla, RockMelt, Safari,
49Sailfish Browser, Samsung Browser, SeaMonkey, Silk, Skyfire, Sleipnir, Slim,
50SlimBrowser, Swiftfox, Tesla, Tizen Browser, UCBrowser, Vivaldi, Waterfox, WeChat,
51Weibo, Yandex, baidu, iCab, w3m, Whale Browser...
52
53# 'browser.version' determined dynamically
54```
55
56* `getDevice()`
57 * returns `{ model: '', type: '', vendor: '' }`
58
59```sh
60# Possible 'device.type':
61console, mobile, tablet, smarttv, wearable, embedded
62
63# Possible 'device.vendor':
64Acer, Alcatel, Amazon, Apple, Archos, ASUS, AT&T, BenQ, BlackBerry, Dell,
65Essential, Fairphone, GeeksPhone, Google, HP, HTC, Huawei, Jolla, Lenovo, LG,
66Meizu, Microsoft, Motorola, Nexian, Nintendo, Nokia, Nvidia, OnePlus, OPPO, Ouya,
67Palm, Panasonic, Pebble, Polytron, Realme, RIM, Samsung, Sharp, Siemens,
68Sony[Ericsson], Sprint, Tesla, Vivo, Vodafone, Xbox, Xiaomi, Zebra, ZTE, ...
69
70# 'device.model' determined dynamically
71```
72
73* `getEngine()`
74 * returns `{ name: '', version: '' }`
75
76```sh
77# Possible 'engine.name'
78Amaya, Blink, EdgeHTML, Flow, Gecko, Goanna, iCab, KHTML, Links, Lynx, NetFront,
79NetSurf, Presto, Tasman, Trident, w3m, WebKit
80
81# 'engine.version' determined dynamically
82```
83
84* `getOS()`
85 * returns `{ name: '', version: '' }`
86
87```sh
88# Possible 'os.name'
89AIX, Amiga OS, Android, Arch, Bada, BeOS, BlackBerry, CentOS, Chromium OS,
90Contiki, Fedora, Firefox OS, FreeBSD, Debian, DragonFly, Fuchsia, Gentoo, GNU,
91Haiku, Hurd, iOS, Joli, KaiOS, Linpus, Linux, Mac OS, Mageia, Mandriva, MeeGo,
92Minix, Mint, Morph OS, NetBSD, Nintendo, OpenBSD, OpenVMS, OS/2, Palm, PC-BSD,
93PCLinuxOS, Plan9, PlayStation, QNX, Raspbian, RedHat, RIM Tablet OS, RISC OS,
94Sailfish, Series40, Slackware, Solaris, SUSE, Symbian, Tizen, Ubuntu, Unix,
95VectorLinux, WebOS, Windows [Phone/Mobile], Zenwalk, ...
96
97# 'os.version' determined dynamically
98```
99
100* `getCPU()`
101 * returns `{ architecture: '' }`
102
103```sh
104# Possible 'cpu.architecture'
10568k, amd64, arm[64/hf], avr, ia[32/64], irix[64], mips[64], pa-risc, ppc, sparc[64]
106```
107
108* `getResult()`
109 * returns `{ ua: '', browser: {}, cpu: {}, device: {}, engine: {}, os: {} }`
110
111* `getUA()`
112 * returns UA string of current instance
113
114* `setUA(uastring)`
115 * set UA string to be parsed
116 * returns current instance
117
118# Usage
119
120## Using HTML
121
122```html
123<!doctype html>
124<html>
125<head>
126<script src="ua-parser.min.js"></script>
127<script>
128
129 var parser = new UAParser();
130 console.log(parser.getResult());
131 /*
132 /// This will print an object structured like this:
133 {
134 ua: "",
135 browser: {
136 name: "",
137 version: "",
138 major: "" //@deprecated
139 },
140 engine: {
141 name: "",
142 version: ""
143 },
144 os: {
145 name: "",
146 version: ""
147 },
148 device: {
149 model: "",
150 type: "",
151 vendor: ""
152 },
153 cpu: {
154 architecture: ""
155 }
156 }
157 */
158 // Default result depends on current window.navigator.userAgent value
159
160 // Now let's try a custom user-agent string as an example
161 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";
162 parser.setUA(uastring1);
163 var result = parser.getResult();
164 // You can also use UAParser constructor directly without having to create an instance:
165 // var result = UAParser(uastring1);
166
167 console.log(result.browser); // {name: "Chromium", version: "15.0.874.106"}
168 console.log(result.device); // {model: undefined, type: undefined, vendor: undefined}
169 console.log(result.os); // {name: "Ubuntu", version: "11.10"}
170 console.log(result.os.version); // "11.10"
171 console.log(result.engine.name); // "WebKit"
172 console.log(result.cpu.architecture); // "amd64"
173
174 // Do some other tests
175 var uastring2 = "Mozilla/5.0 (compatible; Konqueror/4.1; OpenBSD) KHTML/4.1.4 (like Gecko)";
176 console.log(parser.setUA(uastring2).getBrowser().name); // "Konqueror"
177 console.log(parser.getOS()); // {name: "OpenBSD", version: undefined}
178 console.log(parser.getEngine()); // {name: "KHTML", version: "4.1.4"}
179
180 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';
181 console.log(parser.setUA(uastring3).getDevice().model); // "PlayBook"
182 console.log(parser.getOS()) // {name: "RIM Tablet OS", version: "1.0.0"}
183 console.log(parser.getBrowser().name); // "Safari"
184
185</script>
186</head>
187<body>
188</body>
189</html>
190```
191
192## Using node.js
193
194```sh
195$ npm install ua-parser-js
196```
197
198```js
199var http = require('http');
200var parser = require('ua-parser-js');
201
202http.createServer(function (req, res) {
203 // get user-agent header
204 var ua = parser(req.headers['user-agent']);
205 // write the result as response
206 res.end(JSON.stringify(ua, null, ' '));
207})
208.listen(1337, '127.0.0.1');
209
210console.log('Server running at http://127.0.0.1:1337/');
211```
212
213## Using TypeScript
214
215```sh
216$ npm install --save @types/ua-parser-js
217# Download TS type definition from DefinitelyTyped repository:
218# https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ua-parser-js
219```
220
221## Using jQuery/Zepto ($.ua)
222
223Although 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)`.
224
225```js
226// 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':
227
228// Get the details
229console.log($.ua.device); // {vendor: "HTC", model: "Evo Shift 4G", type: "mobile"}
230console.log($.ua.os); // {name: "Android", version: "2.3.4"}
231console.log($.ua.os.name); // "Android"
232console.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"
233
234// Now lets try to reset to another custom user-agent
235$.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');
236
237// Test again
238console.log($.ua.browser.name); // "Safari"
239console.log($.ua.engine.name); // "Webkit"
240console.log($.ua.device); // {vendor: "Motorola", model: "Xoom", type: "tablet"}
241console.log(parseInt($.ua.browser.version.split('.')[0], 10)); // 4
242
243// Add class to <body> tag
244// <body class="ua-browser-safari ua-devicetype-tablet">
245$('body').addClass('ua-browser-' + $.ua.browser.name + ' ua-devicetype-' + $.ua.device.type);
246```
247
248## Using Extension
249
250* `UAParser([uastring,] extensions)`
251
252```js
253// Example:
254var myOwnListOfBrowsers = [
255 [/(mybrowser)\/([\w\.]+)/i], [UAParser.BROWSER.NAME, UAParser.BROWSER.VERSION]
256];
257var myParser = new UAParser({ browser: myOwnListOfBrowsers });
258var myUA = 'Mozilla/5.0 MyBrowser/1.3';
259console.log(myParser.setUA(myUA).getBrowser()); // {name: "MyBrowser", version: "1.3"}
260```
261
262# Development
263
264## Sponsors
265
266<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>
267
268<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>
269
270## Contributors
271
272<a href="https://github.com/faisalman/ua-parser-js/graphs/contributors">
273 <img src="https://contrib.rocks/image?repo=faisalman/ua-parser-js" />
274</a>
275
276Made with [contributors-img](https://contrib.rocks).
277
278## How To Contribute
279
280* Fork and clone this repository
281* Make some changes as required
282* Write unit test to showcase its functionality
283* Run the test suites to make sure it's not breaking anything `$ npm test`
284* Submit a pull request under `develop` branch
285
286# License
287
288MIT License
289
290Copyright (c) 2012-2021 Faisal Salman <<f@faisalman.com>>
291
292Permission is hereby granted, free of charge, to any person obtaining a copy
293of this software and associated documentation files (the "Software"), to deal
294in the Software without restriction, including without limitation the rights
295to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
296copies of the Software, and to permit persons to whom the Software is
297furnished to do so, subject to the following conditions:
298
299The above copyright notice and this permission notice shall be included in all
300copies or substantial portions of the Software.
301
302THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
303IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
304FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
305AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
306LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
307OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
308SOFTWARE.
Note: See TracBrowser for help on using the repository browser.