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" >
< 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 >
< nav >
< 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#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#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 > < a href = "global.html" > Global< / a > < / h3 >
< / nav >
< div id = "main" >
< h1 class = "page-title" > Bowser< / h1 >
< section >
< header >
< h2 >
Bowser
< / h2 >
2018-07-05 19:44:43 +00:00
< div class = "class-description" > < p > Bowser class.
Keep it simple as much as it can be.
It's supposed to work with collections of < a href = "Parser.html" > Parser< / a > instances
rather then solve one-instance problems.
2018-09-09 12:08:48 +00:00
All the one-instance stuff is located in Parser class.< / p > < / div >
< / header >
< article >
< div class = "container-overview" >
< h2 > Constructor< / h2 >
< h4 class = "name" id = "Bowser" > < span class = "type-signature" > < / span > new Bowser< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "bowser.js.html" > bowser.js< / a > , < a href = "bowser.js.html#line16" > line 16< / a >
< / li > < / ul > < / dd >
< / dl >
< / div >
< 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 >
< a href = "bowser.js.html" > bowser.js< / a > , < a href = "bowser.js.html#line29" > line 29< / a >
< / li > < / ul > < / dd >
< / dl >
< div class = "description" >
< p > Creates a module:parser:Parser instance< / p >
< / div >
< h5 > Example< / h5 >
2018-07-05 19:44:43 +00:00
< pre class = "prettyprint" > < code > const bowser = new Bowser(window.navigator.userAgent);
2018-09-09 12:08:48 +00:00
bowser.getResult()< / code > < / pre >
< 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 >
< td class = "description last" > < p > same as skipParsing for < a href = "Parser.html" > Parser< / a > < / p > < / td >
< / tr >
< / tbody >
< / table >
< 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 >
< span class = "param-type" > Error< / span >
< / 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 >
< 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 >
< a href = "bowser.js.html" > bowser.js< / a > , < a href = "bowser.js.html#line42" > line 42< / a >
< / li > < / ul > < / dd >
< / dl >
< div class = "description" >
< p > Creates a < a href = "Parser.html" > Parser< / a > instance and runs Parser.getResult immediately< / p >
< / div >
< 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 >
< 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 >
< / article >
< / section >
< / div >
< br class = "clear" >
< footer >
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.5.5< / a > on Sun Sep 09 2018 15:08:13 GMT+0300 (EEST) using the < a href = "https://github.com/clenemt/docdash" > docdash< / a > theme.
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
2018-07-05 19:44:43 +00:00
< / html >
