Archives/lancedikson_bowser
1
0
Fork 0
mirror of https://github.com/lancedikson/bowser synced 2024-10-27 20:34:22 +00:00
Code Issues Releases Wiki Activity

Improve the browser.check documentation

Browse Source
This commit is contained in:
kerbyfc 2016-08-29 12:59:58 +03:00 committed by GitHub
parent 09e12dcf7a
commit 7a8b91dc6f
1 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -28,18 +28,31 @@ Use it to get object with detected flags of your current browser.
### bowser._detect(ua `:String`)`:Object` ### bowser._detect(ua `:String`)`:Object`
Use it to get object with detected flags from User Agent string. Use it to get object with detected flags from User Agent string.
### bowser.check(minVersions`:Object`, strictMode`:Boolean`, [ua]`:String`)`:Boolean` ### bowser.check(minVersions`:Object`, [strictMode]`:Boolean`, [ua]`:String`)`:Boolean`
Use it to check if browser supported. Use it to check if browser supported.
``` ``` js
browser.check({msie: "11"}, window.navigator.userAgent); /**
// true / false * in case of using IE10
*/
browser.check({msie: "11"}); // true
browser.check({msie: "9.0"}); // false
/**
* specific user agent
*/
browser.check({chome: 45}, window.navigator.userAgent); // true
/**
* but false in strict mode
*/
browesr.check({chome: 45}, true, window.navigator.userAgent); // false
``` ```
### bowser.compareVersions(versions`:Array<String>`)`:Number` ### bowser.compareVersions(versions`:Array<String>`)`:Number`
Use it to compare two versions. Use it to compare two versions.
``` ``` js
browser.compareVersions(['9.0', '10']); browser.compareVersions(['9.0', '10']);
// -1 // -1
``` ```
@ -47,7 +60,7 @@ browser.compareVersions(['9.0', '10']);
### bowser.isUnsupportedBrowser(minVersions`:Object`, [strictMode]`:Boolean`, [ua]`:string`)`:Boolean` ### bowser.isUnsupportedBrowser(minVersions`:Object`, [strictMode]`:Boolean`, [ua]`:string`)`:Boolean`
Use it to check if browser is unsupported. Use it to check if browser is unsupported.
``` ``` js
browser.isUnsupportedBrowser({msie: "10"}, window.navigator.userAgent); browser.isUnsupportedBrowser({msie: "10"}, window.navigator.userAgent);
// true / false // true / false
``` ```