mirror of
https://github.com/lancedikson/bowser
synced 2024-10-27 20:34:22 +00:00
329 lines
11 KiB
HTML
329 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<title>utils.js - 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">
|
|
<script src="scripts/nav.js" defer></script>
|
|
<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#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#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>
|
|
</nav>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">utils.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>import { BROWSER_MAP, BROWSER_ALIASES_MAP } from './constants.js';
|
|
|
|
export default class Utils {
|
|
/**
|
|
* Get first matched item for a string
|
|
* @param {RegExp} regexp
|
|
* @param {String} ua
|
|
* @return {Array|{index: number, input: string}|*|boolean|string}
|
|
*/
|
|
static getFirstMatch(regexp, ua) {
|
|
const match = ua.match(regexp);
|
|
return (match && match.length > 0 && match[1]) || '';
|
|
}
|
|
|
|
/**
|
|
* Get second matched item for a string
|
|
* @param regexp
|
|
* @param {String} ua
|
|
* @return {Array|{index: number, input: string}|*|boolean|string}
|
|
*/
|
|
static getSecondMatch(regexp, ua) {
|
|
const match = ua.match(regexp);
|
|
return (match && match.length > 1 && match[2]) || '';
|
|
}
|
|
|
|
/**
|
|
* Match a regexp and return a constant or undefined
|
|
* @param {RegExp} regexp
|
|
* @param {String} ua
|
|
* @param {*} _const Any const that will be returned if regexp matches the string
|
|
* @return {*}
|
|
*/
|
|
static matchAndReturnConst(regexp, ua, _const) {
|
|
if (regexp.test(ua)) {
|
|
return _const;
|
|
}
|
|
return void (0);
|
|
}
|
|
|
|
static getWindowsVersionName(version) {
|
|
switch (version) {
|
|
case 'NT': return 'NT';
|
|
case 'XP': return 'XP';
|
|
case 'NT 5.0': return '2000';
|
|
case 'NT 5.1': return 'XP';
|
|
case 'NT 5.2': return '2003';
|
|
case 'NT 6.0': return 'Vista';
|
|
case 'NT 6.1': return '7';
|
|
case 'NT 6.2': return '8';
|
|
case 'NT 6.3': return '8.1';
|
|
case 'NT 10.0': return '10';
|
|
default: return undefined;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get macOS version name
|
|
* 10.5 - Leopard
|
|
* 10.6 - Snow Leopard
|
|
* 10.7 - Lion
|
|
* 10.8 - Mountain Lion
|
|
* 10.9 - Mavericks
|
|
* 10.10 - Yosemite
|
|
* 10.11 - El Capitan
|
|
* 10.12 - Sierra
|
|
* 10.13 - High Sierra
|
|
* 10.14 - Mojave
|
|
* 10.15 - Catalina
|
|
*
|
|
* @example
|
|
* getMacOSVersionName("10.14") // 'Mojave'
|
|
*
|
|
* @param {string} version
|
|
* @return {string} versionName
|
|
*/
|
|
static getMacOSVersionName(version) {
|
|
const v = version.split('.').splice(0, 2).map(s => parseInt(s, 10) || 0);
|
|
v.push(0);
|
|
if (v[0] !== 10) return undefined;
|
|
switch (v[1]) {
|
|
case 5: return 'Leopard';
|
|
case 6: return 'Snow Leopard';
|
|
case 7: return 'Lion';
|
|
case 8: return 'Mountain Lion';
|
|
case 9: return 'Mavericks';
|
|
case 10: return 'Yosemite';
|
|
case 11: return 'El Capitan';
|
|
case 12: return 'Sierra';
|
|
case 13: return 'High Sierra';
|
|
case 14: return 'Mojave';
|
|
case 15: return 'Catalina';
|
|
default: return undefined;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get Android version name
|
|
* 1.5 - Cupcake
|
|
* 1.6 - Donut
|
|
* 2.0 - Eclair
|
|
* 2.1 - Eclair
|
|
* 2.2 - Froyo
|
|
* 2.x - Gingerbread
|
|
* 3.x - Honeycomb
|
|
* 4.0 - Ice Cream Sandwich
|
|
* 4.1 - Jelly Bean
|
|
* 4.4 - KitKat
|
|
* 5.x - Lollipop
|
|
* 6.x - Marshmallow
|
|
* 7.x - Nougat
|
|
* 8.x - Oreo
|
|
* 9.x - Pie
|
|
*
|
|
* @example
|
|
* getAndroidVersionName("7.0") // 'Nougat'
|
|
*
|
|
* @param {string} version
|
|
* @return {string} versionName
|
|
*/
|
|
static getAndroidVersionName(version) {
|
|
const v = version.split('.').splice(0, 2).map(s => parseInt(s, 10) || 0);
|
|
v.push(0);
|
|
if (v[0] === 1 && v[1] < 5) return undefined;
|
|
if (v[0] === 1 && v[1] < 6) return 'Cupcake';
|
|
if (v[0] === 1 && v[1] >= 6) return 'Donut';
|
|
if (v[0] === 2 && v[1] < 2) return 'Eclair';
|
|
if (v[0] === 2 && v[1] === 2) return 'Froyo';
|
|
if (v[0] === 2 && v[1] > 2) return 'Gingerbread';
|
|
if (v[0] === 3) return 'Honeycomb';
|
|
if (v[0] === 4 && v[1] < 1) return 'Ice Cream Sandwich';
|
|
if (v[0] === 4 && v[1] < 4) return 'Jelly Bean';
|
|
if (v[0] === 4 && v[1] >= 4) return 'KitKat';
|
|
if (v[0] === 5) return 'Lollipop';
|
|
if (v[0] === 6) return 'Marshmallow';
|
|
if (v[0] === 7) return 'Nougat';
|
|
if (v[0] === 8) return 'Oreo';
|
|
if (v[0] === 9) return 'Pie';
|
|
return undefined;
|
|
}
|
|
|
|
/**
|
|
* Get version precisions count
|
|
*
|
|
* @example
|
|
* getVersionPrecision("1.10.3") // 3
|
|
*
|
|
* @param {string} version
|
|
* @return {number}
|
|
*/
|
|
static getVersionPrecision(version) {
|
|
return version.split('.').length;
|
|
}
|
|
|
|
/**
|
|
* Calculate browser version weight
|
|
*
|
|
* @example
|
|
* compareVersions('1.10.2.1', '1.8.2.1.90') // 1
|
|
* compareVersions('1.010.2.1', '1.09.2.1.90'); // 1
|
|
* compareVersions('1.10.2.1', '1.10.2.1'); // 0
|
|
* compareVersions('1.10.2.1', '1.0800.2'); // -1
|
|
* compareVersions('1.10.2.1', '1.10', true); // 0
|
|
*
|
|
* @param {String} versionA versions versions to compare
|
|
* @param {String} versionB versions versions to compare
|
|
* @param {boolean} [isLoose] enable loose comparison
|
|
* @return {Number} comparison result: -1 when versionA is lower,
|
|
* 1 when versionA is bigger, 0 when both equal
|
|
*/
|
|
/* eslint consistent-return: 1 */
|
|
static compareVersions(versionA, versionB, isLoose = false) {
|
|
// 1) get common precision for both versions, for example for "10.0" and "9" it should be 2
|
|
const versionAPrecision = Utils.getVersionPrecision(versionA);
|
|
const versionBPrecision = Utils.getVersionPrecision(versionB);
|
|
|
|
let precision = Math.max(versionAPrecision, versionBPrecision);
|
|
let lastPrecision = 0;
|
|
|
|
const chunks = Utils.map([versionA, versionB], (version) => {
|
|
const delta = precision - Utils.getVersionPrecision(version);
|
|
|
|
// 2) "9" -> "9.0" (for precision = 2)
|
|
const _version = version + new Array(delta + 1).join('.0');
|
|
|
|
// 3) "9.0" -> ["000000000"", "000000009"]
|
|
return Utils.map(_version.split('.'), chunk => new Array(20 - chunk.length).join('0') + chunk).reverse();
|
|
});
|
|
|
|
// adjust precision for loose comparison
|
|
if (isLoose) {
|
|
lastPrecision = precision - Math.min(versionAPrecision, versionBPrecision);
|
|
}
|
|
|
|
// iterate in reverse order by reversed chunks array
|
|
precision -= 1;
|
|
while (precision >= lastPrecision) {
|
|
// 4) compare: "000000009" > "000000010" = false (but "9" > "10" = true)
|
|
if (chunks[0][precision] > chunks[1][precision]) {
|
|
return 1;
|
|
}
|
|
|
|
if (chunks[0][precision] === chunks[1][precision]) {
|
|
if (precision === lastPrecision) {
|
|
// all version chunks are same
|
|
return 0;
|
|
}
|
|
|
|
precision -= 1;
|
|
} else if (chunks[0][precision] < chunks[1][precision]) {
|
|
return -1;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Array::map polyfill
|
|
*
|
|
* @param {Array} arr
|
|
* @param {Function} iterator
|
|
* @return {Array}
|
|
*/
|
|
static map(arr, iterator) {
|
|
const result = [];
|
|
let i;
|
|
if (Array.prototype.map) {
|
|
return Array.prototype.map.call(arr, iterator);
|
|
}
|
|
for (i = 0; i < arr.length; i += 1) {
|
|
result.push(iterator(arr[i]));
|
|
}
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Get short version/alias for a browser name
|
|
*
|
|
* @example
|
|
* getBrowserAlias('Microsoft Edge') // edge
|
|
*
|
|
* @param {string} browserName
|
|
* @return {string}
|
|
*/
|
|
static getBrowserAlias(browserName) {
|
|
return BROWSER_ALIASES_MAP[browserName];
|
|
}
|
|
|
|
/**
|
|
* Get short version/alias for a browser name
|
|
*
|
|
* @example
|
|
* getBrowserAlias('edge') // Microsoft Edge
|
|
*
|
|
* @param {string} browserName
|
|
* @return {string}
|
|
*/
|
|
static getBrowserTypeByAlias(browserAlia) {
|
|
return BROWSER_MAP[browserAlia] || '';
|
|
}
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Aug 04 2019 23:53:02 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>
|