2018-09-09 12:08:48 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Bowser - Documentation< / title >
< script src = "scripts/prettify/prettify.js" > < / script >
< script src = "scripts/prettify/lang-css.js" > < / script >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/prettify.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/jsdoc.css" >
2019-07-16 19:21:01 +00:00
< script src = "scripts/nav.js" defer > < / script >
2018-09-09 12:08:48 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< / head >
< body >
< input type = "checkbox" id = "nav-trigger" class = "nav-trigger" / >
< label for = "nav-trigger" class = "navicon-button x" >
< div class = "navicon" > < / div >
< / label >
< label for = "nav-trigger" class = "overlay" > < / label >
2019-07-16 19:21:01 +00:00
< nav >
2018-09-09 12:08:48 +00:00
2020-07-09 19:11:59 +00:00
< h2 > < a href = "index.html" > Home< / a > < / h2 > < h3 > Classes< / h3 > < ul > < li > < a href = "Bowser.html" > Bowser< / a > < ul class = 'methods' > < li data-type = 'method' > < a href = "Bowser.html#.getParser" > getParser< / a > < / li > < li data-type = 'method' > < a href = "Bowser.html#.parse" > parse< / a > < / li > < / ul > < / li > < li > < a href = "Parser.html" > Parser< / a > < ul class = 'methods' > < li data-type = 'method' > < a href = "Parser.html#getBrowser" > getBrowser< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getBrowserName" > getBrowserName< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getBrowserVersion" > getBrowserVersion< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getEngine" > getEngine< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getEngineName" > getEngineName< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getOS" > getOS< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getOSName" > getOSName< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getOSVersion" > getOSVersion< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getPlatform" > getPlatform< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getPlatformType" > getPlatformType< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getResult" > getResult< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#getUA" > getUA< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#is" > is< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#isBrowser" > isBrowser< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#parse" > parse< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#parseBrowser" > parseBrowser< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#parseEngine" > parseEngine< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#parseOS" > parseOS< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#parsePlatform" > parsePlatform< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#satisfies" > satisfies< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#some" > some< / a > < / li > < li data-type = 'method' > < a href = "Parser.html#test" > test< / a > < / li > < / ul > < / li > < / ul > < h3 > Global< / h3 > < ul > < li > < a href = "global.html#assign" > assign< / a > < / li > < li > < a href = "global.html#find" > find< / a > < / li > < li > < a href = "global.html#getAndroidVersionName" > getAndroidVersionName< / a > < / li > < li > < a href = "global.html#getBrowserAlias" > getBrowserAlias< / a > < / li > < li > < a href = "global.html#getBrowserTypeByAlias" > getBrowserTypeByAlias< / a > < / li > < li > < a href = "global.html#getFirstMatch" > getFirstMatch< / a > < / li > < li > < a href = "global.html#getMacOSVersionName" > getMacOSVersionName< / a > < / li > < li > < a href = "global.html#getSecondMatch" > getSecondMatch< / a > < / li > < li > < a href = "global.html#getVersionPrecision" > getVersionPrecision< / a > < / li > < li > < a href = "global.html#map" > map< / a > < / li > < li > < a href = "global.html#matchAndReturnConst" > matchAndReturnConst< / a > < / li > < / ul >
2018-09-09 12:08:48 +00:00
< / nav >
< div id = "main" >
< h1 class = "page-title" > Bowser< / h1 >
< section >
< header >
< h2 >
Bowser
< / h2 >
2019-07-16 19:21:01 +00:00
< div class = "class-description" > < p > Bowser is a static object, that provides an API to the Parsers< / p > < / div >
2018-09-09 12:08:48 +00:00
< / header >
< article >
< h3 class = "subsection-title" > Methods< / h3 >
< h4 class = "name" id = ".getParser" > < span class = "type-signature" > (static) < / span > getParser< span class = "signature" > (UA, skipParsing< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {< a href = "Parser.html" > Parser< / a > }< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-07-17 10:52:54 +00:00
< a href = "bowser.js.html" > bowser.js< / a > , < a href = "bowser.js.html#line40" > line 40< / a >
2018-09-09 12:08:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< div class = "description" >
2019-07-16 19:21:01 +00:00
< p > Creates a < a href = "Parser.html" > Parser< / a > instance< / p >
2018-09-09 12:08:48 +00:00
< / div >
< h5 > Example< / h5 >
2018-10-19 17:32:59 +00:00
< pre class = "prettyprint" > < code > const parser = Bowser.getParser(window.navigator.userAgent);
const result = parser.getResult();< / code > < / pre >
2018-09-09 12:08:48 +00:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > UA< / code > < / td >
< td class = "type" >
< span class = "param-type" > String< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > UserAgent string< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > skipParsing< / code > < / td >
< td class = "type" >
< span class = "param-type" > Boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
< code > false< / code >
< / td >
2019-07-16 19:21:01 +00:00
< td class = "description last" > < p > Will make the Parser postpone parsing until you ask it
explicitly. Same as < code > skipParsing< / code > for < a href = "Parser.html" > Parser< / a > .< / p > < / td >
2018-09-09 12:08:48 +00:00
< / tr >
< / tbody >
< / table >
2019-07-16 19:21:01 +00:00
2018-09-09 12:08:48 +00:00
< h5 > Throws:< / h5 >
< dl >
< dt >
< div class = "param-desc" >
< p > when UA is not a String< / p >
< / div >
< / dt >
< dd > < / dd >
< dt >
< dl class = "param-type" >
< dt >
Type
< / dt >
< dd >
2019-07-17 10:52:54 +00:00
< span class = "param-type" > Error< / span >
2018-09-09 12:08:48 +00:00
< / dd >
< / dl >
< / dt >
< dd > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl class = "param-type" >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Parser.html" > Parser< / a > < / span >
< / dd >
< / dl >
2019-07-16 19:21:01 +00:00
2018-09-09 12:08:48 +00:00
< h4 class = "name" id = ".parse" > < span class = "type-signature" > (static) < / span > parse< span class = "signature" > (UA)< / span > < span class = "type-signature" > → {< a href = "global.html#ParsedResult" > ParsedResult< / a > }< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-07-17 10:52:54 +00:00
< a href = "bowser.js.html" > bowser.js< / a > , < a href = "bowser.js.html#line56" > line 56< / a >
2018-09-09 12:08:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< div class = "description" >
< p > Creates a < a href = "Parser.html" > Parser< / a > instance and runs Parser.getResult immediately< / p >
< / div >
2018-10-19 17:32:59 +00:00
< h5 > Example< / h5 >
< pre class = "prettyprint" > < code > const result = Bowser.parse(window.navigator.userAgent);< / code > < / pre >
2018-09-09 12:08:48 +00:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > UA< / code > < / td >
< td class = "type" >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
2019-07-16 19:21:01 +00:00
2018-09-09 12:08:48 +00:00
< h5 > Returns:< / h5 >
< dl class = "param-type" >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "global.html#ParsedResult" > ParsedResult< / a > < / span >
< / dd >
< / dl >
2019-07-16 19:21:01 +00:00
2018-09-09 12:08:48 +00:00
< / article >
< / section >
< / div >
< br class = "clear" >
< footer >
2020-07-09 19:11:59 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.6.3< / a > on Thu Jul 09 2020 22:10:18 GMT+0300 (Eastern European Summer Time) using the < a href = "https://github.com/clenemt/docdash" > docdash< / a > theme.
2018-09-09 12:08:48 +00:00
< / footer >
< script > prettyPrint ( ) ; < / script >
2019-07-16 19:21:01 +00:00
< script src = "scripts/polyfill.js" > < / script >
2018-09-09 12:08:48 +00:00
< script src = "scripts/linenumber.js" > < / script >
2019-07-16 19:21:01 +00:00
2018-09-09 12:08:48 +00:00
< / body >
2018-07-05 19:44:43 +00:00
< / html >
