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

add API section

Browse Source
This commit is contained in:
Denis Demchenko 2016-06-30 20:52:55 +03:00
parent ab46669db8
commit c0106d31f2
1 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -18,6 +18,44 @@ Also you can download minified file from [the release page](https://github.com/d
## 1.0.0 breaking changes
`browser = require('bowser').browser;` becomes `browser = require('bowser');`
---
## API
### bowser()`:Object`
Use it to get object with detected flags of your current browser.
### bowser._detect(ua `:String`)`:Object`
Use it to get object with detected flags from User Agent string.
### bowser.check(minVersions`:Object`, strictMode`:Boolean`)`:Boolean`
Use it to check if browser supported.
```
browser.check({msie: "11"}, window.navigator.userAgent);
// true / false
```
### bowser.compareVersions(versions`:Array<String>`)`:Number`
Use it to compare two versions.
```
browser.compareVersions(['9.0', '10']);
// -1
```
### bowser.isUnsupportedBrowser(minVersions`:Object`, [strictMode]`:Boolean`, [ua]`:string`)`:Boolean`
Use it to check if browser is unsupported.
```
browser.isUnsupportedBrowser({msie: "10"}, window.navigator.userAgent);
// true / false
```
See more examples in [tests](test/test.js).
---
## Bowser Flags
Your mileage may vary, but these flags should be set. See Contributing below.