mirror of
https://github.com/faisalman/ua-parser-js.git
synced 2025-09-29 17:04:26 +03:00
Adapt js to be compatible with Node.js as module
This commit is contained in:
44
readme.md
44
readme.md
@@ -5,28 +5,32 @@ JavaScript-based user-agent parser
|
||||
* Author : Faisalman <<fyzlman@gmail.com>>
|
||||
* Home : http://faisalman.github.com/ua-parser-js
|
||||
* Source : https://github.com/faisalman/ua-parser-js
|
||||
* License : GPLv2
|
||||
* License : GPLv2 & MIT
|
||||
|
||||
## Features
|
||||
|
||||
Get detailed type and version of web browser, layout engine, and operating system.
|
||||
Get detailed type and version of web browser, layout engine, operating system, and device.
|
||||
|
||||
## Methods
|
||||
|
||||
* `getBrowser([uastring])`
|
||||
* `getEngine([uastring])`
|
||||
* `getOS([uastring])`
|
||||
* `getDevice([uastring])`
|
||||
* `setUA(uastring)`
|
||||
|
||||
## Properties
|
||||
|
||||
* `result`
|
||||
|
||||
## Example
|
||||
|
||||
```html
|
||||
<script type="text/javascript" src="ua-parser.js"></script>
|
||||
<script type="text/javascript">
|
||||
|
||||
var p = new UAParser(); // if no string given as parameter, by default it takes ua string from current browser's window.navigator
|
||||
|
||||
console.log(p.result);
|
||||
// by default it takes ua string from current browser's window.navigator
|
||||
console.log(UAParser.result);
|
||||
/*
|
||||
/// this will print an object structured like this:
|
||||
{
|
||||
@@ -42,20 +46,42 @@ Get detailed type and version of web browser, layout engine, and operating syste
|
||||
os: {
|
||||
name: "",
|
||||
version: ""
|
||||
},
|
||||
device: {
|
||||
name: "",
|
||||
version: ""
|
||||
}
|
||||
}
|
||||
*/
|
||||
|
||||
// let's test a custom user-agent string as an example
|
||||
p.setUA("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");
|
||||
var uastr = "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";
|
||||
UAParser.setUA(uastr);
|
||||
|
||||
console.log(p.result.browser); // {name: "Chromium", major: "15", version: "15.0.874.106"}
|
||||
console.log(p.result.engine); // {name: "AppleWebKit", version: "535.2"}
|
||||
console.log(p.result.os); // {name: "Ubuntu", version: "11.10"}
|
||||
console.log(UAParser.result.browser); // {name: "Chromium", major: "15", version: "15.0.874.106"}
|
||||
console.log(UAParser.result.engine); // {name: "AppleWebKit", version: "535.2"}
|
||||
console.log(UAParser.result.os); // {name: "Ubuntu", version: "11.10"}
|
||||
|
||||
// let's take another test please
|
||||
UAParser.setUA("Mozilla/5.0 (compatible; Konqueror/4.1; OpenBSD) KHTML/4.1.4 (like Gecko)").getOS().name; // prints "OpenBSD"
|
||||
</script>
|
||||
```
|
||||
|
||||
## Using node.js
|
||||
|
||||
```js
|
||||
var parser = require('ua-parser');
|
||||
|
||||
var ua1 = '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';
|
||||
var ua2 = 'Midori/0.2 (X11; Linux; U; cs-cz) WebKit/531.2+';
|
||||
|
||||
parser.setUA(ua1).getDevice().name; // prints "PlayBook"
|
||||
parser.getOS() // prints {name: "RIM Tablet OS", version: "1.0.0"}
|
||||
parser.getOS(ua2) // prints {name: "Linux", version: undefined}
|
||||
parser.getOS() // prints {name: "RIM Tablet OS", version: "1.0.0"}
|
||||
parser.getEngine().name; // prints "AppleWebKit"
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Copyright © 2012 Faisalman <<fyzlman@gmail.com>>
|
||||
|
Reference in New Issue
Block a user