Merge branch 'release/2.5.0' into production

bowser-js · Jul 16, 2019 · 5fc17b7 · 5fc17b7
2 parents 5a6dcc2 + fb19176
commit 5fc17b7
Show file tree

Hide file tree

Showing 28 changed files with 4,445 additions and 6,889 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,2 @@
+github: lancedikson
+open_collective: lancedikson
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,7 @@
 language: node_js
 after_success: npm run coverage
 node_js:
-  - "8.4.0"
+  - "12"
 script:
 - npm run lint
 - npm run build

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Bowser Changelog
 
+### 2.5.0 (July 16, 2019)
+- [ADD] Add constant output so that users can quickly get all types (#325)
+- [FIX] Add support for Roku OS (#332)
+- [FIX] Update devDependencies
+- [FIX] Fix docs, README and added funding information
+
 ### 2.4.0 (May 3, 2019)
 - [FIX] Update regexp for generic browsers (#310)
 - [FIX] Fix issues with module.exports (#318)

diff --git a/README.md b/README.md
@@ -1,7 +1,12 @@
 ## Bowser
-A browser detector. Because sometimes, there is no other way, and not even good modern browsers always provide good feature detection mechanisms.
+A small, fast and reach-API browser/platform/engine detector for both browser and node.
+- **Small.** Use plain ES5-version which is ~4.8kB gzipped.
+- **Optimized.** Use only those parsers you need — it doesn't do useless work.
+- **Multi-platform.** It's browser- and node-ready, so you can use it in any environment.
 
-[![Build Status](https://travis-ci.org/lancedikson/bowser.svg?branch=master)](https://travis-ci.org/lancedikson/bowser/) [![Greenkeeper badge](https://badges.greenkeeper.io/lancedikson/bowser.svg)](https://greenkeeper.io/)[![Coverage Status](https://coveralls.io/repos/github/lancedikson/bowser/badge.svg?branch=master)](https://coveralls.io/github/lancedikson/bowser?branch=master)
+Don't hesitate to support the project on Github or [OpenCollective](https://opencollective.com/bowser) if you like it ❤️ Also, contributors are always welcome!
+
+[![Build Status](https://travis-ci.org/lancedikson/bowser.svg?branch=master)](https://travis-ci.org/lancedikson/bowser/)  [![Greenkeeper badge](https://badges.greenkeeper.io/lancedikson/bowser.svg)](https://greenkeeper.io/)  [![Coverage Status](https://coveralls.io/repos/github/lancedikson/bowser/badge.svg?branch=master)](https://coveralls.io/github/lancedikson/bowser?branch=master)
 
 # Contents
 - [Overview](#overview)

diff --git a/docs/Bowser.html b/docs/Bowser.html
@@ -13,6 +13,7 @@
     <![endif]-->
     <link type="text/css" rel="stylesheet" href="styles/prettify.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <script src="scripts/nav.js" defer></script>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 </head>
 <body>
@@ -24,9 +25,9 @@
 
 <label for="nav-trigger" class="overlay"></label>
 
-<nav>
+<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#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#getAndroidVersionName">getAndroidVersionName</a></li><li><a href="global.html#getBrowserAlias">getBrowserAlias</a></li><li><a href="global.html#getFirstMatch">getFirstMatch</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>
+    <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="BowserUAIsNotAStringError.html">BowserUAIsNotAStringError</a></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#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#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>
 </nav>
 
 <div id="main">
@@ -47,108 +48,20 @@ <h2>
         Bowser
         </h2>
 
-            <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.
-All the one-instance stuff is located in Parser class.</p></div>
+            <div class="class-description"><p>Bowser is a static object, that provides an API to the Parsers</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>
-
-
-
-
-
-
 
 
 
@@ -177,7 +90,7 @@ <h4 class="name" id=".getParser"><span class="type-signature">(static) </span>ge
 
     <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>
+        <a href="bowser.js.html">bowser.js</a>, <a href="bowser.js.html#line51">line 51</a>
     </li></ul></dd>
 
 
@@ -217,7 +130,7 @@ <h4 class="name" id=".getParser"><span class="type-signature">(static) </span>ge
 
 
 <div class="description">
-    <p>Creates a module:parser:Parser instance</p>
+    <p>Creates a <a href="Parser.html">Parser</a> instance</p>
 </div>
 
 
@@ -332,7 +245,8 @@ <h5>Parameters:</h5>
                 </td>
 
 
-            <td class="description last"><p>same as skipParsing for <a href="Parser.html">Parser</a></p></td>
+            <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>
         </tr>
 
 
@@ -350,6 +264,8 @@ <h5>Parameters:</h5>
 
 
 
+
+
 <h5>Throws:</h5>
 
 
@@ -368,7 +284,7 @@ <h5>Throws:</h5>
             </dt>
             <dd>
 
-<span class="param-type">Error</span>
+<span class="param-type"><a href="BowserUAIsNotAStringError.html">BowserUAIsNotAStringError</a></span>
 
 
             </dd>
@@ -401,6 +317,7 @@ <h5>Returns:</h5>
 
 
 
+
 
 
 
@@ -418,7 +335,7 @@ <h4 class="name" id=".parse"><span class="type-signature">(static) </span>parse<
 
     <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#line45">line 45</a>
+        <a href="bowser.js.html">bowser.js</a>, <a href="bowser.js.html#line67">line 67</a>
     </li></ul></dd>
 
 
@@ -532,6 +449,8 @@ <h5>Parameters:</h5>
 
 
 
+
+
 <h5>Returns:</h5>
 
 
@@ -552,6 +471,7 @@ <h5>Returns:</h5>
 
 
 
+
 
 
 
@@ -572,12 +492,14 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri May 03 2019 21:50:23 GMT+0300 (EEST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jul 16 2019 22:20:27 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
+<script src="scripts/polyfill.js"></script>
 <script src="scripts/linenumber.js"></script>
 
 
+
 </body>
 </html>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		github: lancedikson
		open_collective: lancedikson