mirror of
https://github.com/faisalman/ua-parser-js.git
synced 2025-09-27 16:08:47 +03:00
Readme: update is() & toString() methods explanation
This commit is contained in:
parent
96fb3a5ed5
commit
746ac28f94
68
readme.md
68
readme.md
@ -163,6 +163,32 @@ Ubuntu, Unix, VectorLinux, Viera, WebOS, Windows [Phone/Mobile], Zenwalk, ...
|
|||||||
#### * is() utility `since@1.1`
|
#### * is() utility `since@1.1`
|
||||||
|
|
||||||
```js
|
```js
|
||||||
|
// Is just a shorthand to check whether one of the specified properties has equal value
|
||||||
|
// so that instead of write it using `==` operator like this:
|
||||||
|
|
||||||
|
let ua = UAParser();
|
||||||
|
let device = ua.device;
|
||||||
|
let os = ua.os;
|
||||||
|
|
||||||
|
if (device.type == "mobile" && os.name != "iOS") {}
|
||||||
|
if (device.type == "smarttv" || device.vendor == "Samsung") {}
|
||||||
|
|
||||||
|
// we can also write the comparison above into as follow:
|
||||||
|
|
||||||
|
if (device.is("mobile") && !os.is("iOS")) {}
|
||||||
|
if (device.is("smarttv") || device.is("Samsung")) {}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Properties will be checked in this particular order:
|
||||||
|
* browser : name
|
||||||
|
* cpu : architecture
|
||||||
|
* device : type, model, vendor
|
||||||
|
* engine : name
|
||||||
|
* os : name
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Another examples:
|
||||||
|
|
||||||
let uap = new UAParser('Mozilla/5.0 (Mobile; Windows Phone 8.1; Android 4.0; ARM; Trident/7.0; Touch; rv:11.0; IEMobile/11.0; NOKIA; Lumia 635) like iPhone OS 7_0_3 Mac OS X AppleWebKit/537 (KHTML, like Gecko) Mobile Safari/537');
|
let uap = new UAParser('Mozilla/5.0 (Mobile; Windows Phone 8.1; Android 4.0; ARM; Trident/7.0; Touch; rv:11.0; IEMobile/11.0; NOKIA; Lumia 635) like iPhone OS 7_0_3 Mac OS X AppleWebKit/537 (KHTML, like Gecko) Mobile Safari/537');
|
||||||
|
|
||||||
uap.getBrowser().name; // "IEMobile"
|
uap.getBrowser().name; // "IEMobile"
|
||||||
@ -183,20 +209,43 @@ uap.getResult().device.is("Nokia"); // true
|
|||||||
uap.getResult().device.model; // "Lumia 635"
|
uap.getResult().device.model; // "Lumia 635"
|
||||||
|
|
||||||
uap.setUA("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36");
|
uap.setUA("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36");
|
||||||
uap.getBrowser().is("IEMobile"); // false
|
|
||||||
uap.getBrowser().is("Chrome"); // true
|
let browser = uap.getBrowser();
|
||||||
|
browser.is("IEMobile"); // false
|
||||||
|
browser.is("Chrome"); // true
|
||||||
|
|
||||||
uap.getResult().browser.is("Edge"); // false
|
uap.getResult().browser.is("Edge"); // false
|
||||||
|
uap.getResult().os.name // "Mac OS"
|
||||||
uap.getResult().os.is("Mac OS"); // true
|
uap.getResult().os.is("Mac OS"); // true
|
||||||
uap.getResult().os.version; // "10.6.8"
|
uap.getResult().os.version; // "10.6.8"
|
||||||
uap.getEngine().is("Blink"); // true
|
|
||||||
|
let engine = uap.getEngine();
|
||||||
|
engine.is("Blink"); // true
|
||||||
```
|
```
|
||||||
|
|
||||||
#### * toString() utility `since@1.1`
|
#### * toString() utility `since@1.1`
|
||||||
|
|
||||||
```js
|
```js
|
||||||
|
// Retrieve full-name values as a string
|
||||||
|
|
||||||
|
/*
|
||||||
|
Values will be concatenated following this pattern:
|
||||||
|
* browser : name + version
|
||||||
|
* cpu : architecture
|
||||||
|
* device : vendor + model
|
||||||
|
* engine : name + version
|
||||||
|
* os : name + version
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Usage examples
|
||||||
|
|
||||||
let uap = new UAParser('Mozilla/5.0 (Mobile; Windows Phone 8.1; Android 4.0; ARM; Trident/7.0; Touch; rv:11.0; IEMobile/11.0; NOKIA; Lumia 635) like iPhone OS 7_0_3 Mac OS X AppleWebKit/537 (KHTML, like Gecko) Mobile Safari/537');
|
let uap = new UAParser('Mozilla/5.0 (Mobile; Windows Phone 8.1; Android 4.0; ARM; Trident/7.0; Touch; rv:11.0; IEMobile/11.0; NOKIA; Lumia 635) like iPhone OS 7_0_3 Mac OS X AppleWebKit/537 (KHTML, like Gecko) Mobile Safari/537');
|
||||||
|
|
||||||
uap.getDevice(); // { vendor: "Nokia", model: "Lumia 635", type: "mobile" }
|
uap.getDevice(); // {
|
||||||
|
// vendor: "Nokia",
|
||||||
|
// model: "Lumia 635",
|
||||||
|
// type: "mobile"
|
||||||
|
// }
|
||||||
uap.getDevice().toString(); // "Nokia Lumia 635"
|
uap.getDevice().toString(); // "Nokia Lumia 635"
|
||||||
|
|
||||||
uap.getResult().os.name; // "Windows Phone"
|
uap.getResult().os.name; // "Windows Phone"
|
||||||
@ -204,10 +253,15 @@ uap.getResult().os.version; // "8.1"
|
|||||||
uap.getResult().os.toString(); // "Windows Phone 8.1"
|
uap.getResult().os.toString(); // "Windows Phone 8.1"
|
||||||
|
|
||||||
uap.setUA("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36");
|
uap.setUA("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36");
|
||||||
uap.getBrowser().name; // Chrome
|
uap.getBrowser().name; // "Chrome"
|
||||||
uap.getBrowser().version; // 28.0.1500.95
|
uap.getBrowser().version; // "28.0.1500.95"
|
||||||
uap.getBrowser().major; // 28
|
uap.getBrowser().major; // "28"
|
||||||
uap.getBrowser().toString(); // "Chrome 28.0.1500.95"
|
uap.getBrowser().toString(); // "Chrome 28.0.1500.95"
|
||||||
|
|
||||||
|
let engine = uap.getEngine();
|
||||||
|
engine.name; // "Blink"
|
||||||
|
engine.version; // "28.0.1500.95"
|
||||||
|
engine.toString(); // "Blink 28.0.1500.95"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Extending Regex
|
## Extending Regex
|
||||||
|
Loading…
x
Reference in New Issue
Block a user