mazey 3.2.0 → 3.3.0

package/README.md

@@ -1,496 +1,532 @@
-English | [简体中文](./README_CN.md)
-
-# mazey
-
-[![NPM version][npm-image]][npm-url]
-[![l][l-image]][l-url]
-
-[npm-image]: https://img.shields.io/npm/v/mazey
-[npm-url]: https://npmjs.org/package/mazey
-[l-image]: https://img.shields.io/npm/l/mazey
-[l-url]: https://github.com/mazeyqian/mazey
-
-Mazey's library for front end.
-
-## Install
-
-You can get mazey via [npm](https://www.npmjs.com/package/mazey).
-
-```
-npm install mazey --save
-```
-
-## Usage
-
-### Load Resource
-
-#### Load JavaScript
-
-```
-import { loadScript } from 'mazey';
-
-loadScript(
-    'http://example.com/js/plugin/jquery/jquery-2.1.1.min.js',
-    {
-      id: 'iamid', // Optional, script ID, default none
-      timeout: 5000, // Optional, timeout, default `5000`
-      isDefer: false, // Optional, defer, default `false`
-    }
-  )
-  .then(
-    res => {
-      console.log(`Load JavaScript Success: ${res}`);
-    }
-  )
-  .catch(
-    err => {
-      console.error(`Load JavaScript Fail: ${err}`)
-    }
-  );
-```
-
-#### Load CSS
-
-```
-import { loadCSS } from 'mazey';
-
-loadCSS(
-    'http://example.com/css/mazey-base.css',
-    {
-      id: 'iamid', // Optional, link ID, default none
-    }
-  )
-  .then(
-    res => {
-      console.log(`Load CSS Success: ${res}`);
-    }
-  )
-  .catch(
-    err => {
-      console.error(`Load CSS Fail: ${err}`)
-    }
-  );
-```
-
-#### Check Load
-
-Check whether the page is loaded successfully (Keepe the compatibility in case that browser's `load` event has been triggered).
-
-```
-import { windowLoaded } from 'mazey';
-
-windowLoaded(30) // second
-  .then(res => {
-    console.log(`Load Success: ${res}`); // Load Success: load
-  })
-  .catch(err => {
-    console.log(`Load Timeout or Fail: ${err}`);
-  });
-```
-### Function
-
-#### Debounce
-
-```
-import { debounce } from 'mazey';
-
-const foo = debounce(() => {
-  console.log('The debounced function will only be invoked in 1000 milliseconds, the other invoking will disappear during the wait time.');
-}, 1000, { leading: true })
-```
-
-#### Throttle
-
-```
-import { throttle } from 'mazey';
-
-const foo = throttle(() => {
-  console.log('The function will be invoked at most once per every wait 1000 milliseconds.');
-}, 1000, { leading: true })
-```
-
-#### Check Number
-
-Check whether it is a right number.
-
-```
-import { isNumber } from 'mazey';
-
-isNumber(123); // true
-isNumber('123'); // false
-// Default: NaN, Infinity is not Number
-isNumber(Infinity); // false
-isNumber(Infinity, { isUnFiniteAsNumber: true }); true
-isNumber(NaN); // false
-isNumber(NaN, { isNaNAsNumber: true, isUnFiniteAsNumber: true }); // true
-```
-
-#### Camel Case
-
-Transfer CamelCase to KebabCase.
-
-```
-import { camelCaseToKebabCase } from 'mazey';
-
-camelCaseToKebabCase('ABC'); // a-b-c
-camelCaseToKebabCase('aBC'); // a-b-c
-```
-
-Transfer CamelCase to Underscore.
-
-```
-import { camelCase2Underscore } from 'mazey';
-
-camelCase2Underscore('ABC'); // a_b_c
-camelCase2Underscore('aBC'); // a_b_c
-```
-
-#### Trim
-
-Remove leading and trailing whitespace or specified characters from string.
-
-```
-import { mTrim } from 'mazey';
-
-mTrim(' 1 2 3 '); // '1 2 3'
-mTrim('abc '); // 'abc'
-```
-
-#### Deep Clone
-
-Clone Object deeply.
-
-```
-import { deepCopyObject } from 'mazey';
-
-deepCopyObject(['a', 'b', 'c']); // ['a', 'b', 'c']
-deepCopyObject('abc'); // 'abc'
-```
-
-#### JSON
-
-Check whether it is a valid JSON string.
-
-```
-import { isJsonString } from 'mazey';
-
-isJsonString(`['a', 'b', 'c']`); // false
-isJsonString(`["a", "b", "c"]`); // true
-```
-
-#### Random
-
-Produce a random string of number, `generateRndNum(7)` => '7658495'.
-
-```
-import { generateRndNum } from 'mazey';
-
-generateRndNum(4); // '9730'
-generateRndNum(7); // '2262490'
-```
-
-### DOM
-
-#### Class
-
-Modify `class`.
-
-```
-import { hasClass, addClass, removeClass } from 'mazey';
-
-const dom = document.querySelector('#box');
-
-// Determine `class`
-hasClass(dom, 'test');
-// Add `class`
-addClass(dom, 'test');
-// Remove `class`
-removeClass(dom, 'test');
-```
-
-#### Style
-
-Add `<style>` in `<head>`.
-
-Case 1: Add the `<style>` with `id`, and repeated invoking will update the content instead of adding a new one.
-
-```
-import { addStyle } from 'mazey';
-
-addStyle(
-  `
-    body {
-      background-color: #333;
-    }
-  `,
-  {
-    id: 'test',
-  }
-);
-// <style id="test">
-//   body {
-//     background-color: #333;
-//   }
-// </style>
-```
-
-Case 2: Add the `<style>` without `id`, and repeated invoking will adding a new one.
-
-```
-import { addStyle } from 'mazey';
-
-addStyle(
-  `
-    body {
-      background-color: #444;
-    }
-  `
-);
-// <style>
-//   body {
-//     background-color: #444;
-//   }
-// </style>
-```
-
-#### Newline
-
-Make a newline of HTML.
-
-```
-import { newLine } from 'mazey';
-
-newLine('a\nb\nc'); // 'a<br />b<br />c'
-newLine('a\n\nbc'); // 'a<br /><br />bc'
-```
-
-### URL
-
-#### Query Param
-
-Get the query param's value of the current Web URL(`location.search`).
-
-```
-import { getQueryParam } from 'mazey';
-
-// http://example.com/?t1=1&t2=2&t3=3&t4=4#2333
-// ?t1=1&t2=2&t3=3&t4=4
-getQueryParam('t3'); // 3
-getQueryParam('t4'); // 4
-```
-
-Get the query param's value of the input URL.
-
-```
-import { getUrlParam } from 'mazey';
-
-getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3'); // 3
-getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4'); // 4
-```
-
-#### Update Param
-
-Update the query param's value of the input URL.
-
-```
-import { updateQueryParam } from 'mazey';
-
-updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3', 'three'); // http://example.com/?t1=1&t2=2&t3=three&t4=4
-updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4', 'four'); // http://example.com/?t1=1&t2=2&t3=3&t4=four
-```
-
-#### Hash Param
-
-Get the hash query param's value of the current Web URL(`location.hash`).
-
-```
-import { getHashQueryParam } from 'mazey';
-
-// http://example.com/?#2333?t1=1&t2=2&t3=3&t4=4
-// #2333?t1=1&t2=2&t3=3&t4=4
-getHashQueryParam('t3'); // 3
-getHashQueryParam('t4'); // 4
-```
-
-#### Domain
-
-Get the domain of URL, and other params.
-
-```
-import { getDomain } from 'mazey';
-
-getDomain('http://example.com/?t1=1&t2=2&t3=3&t4=4'); // example.com
-getDomain('http://example.com/test/thanks?t1=1&t2=2&t3=3&t4=4', ['hostname', 'pathname']); // example.com/test/thanks
-```
-
-### Cache Data
-
-#### Storage
-
-Handle Storage (Keep fit for JSON, it can tansfer format automatically).
-
-```
-import { setSessionStorage, getSessionStorage, setLocalStorage, getLocalStorage } from 'mazey';
-
-setSessionStorage('test', '123');
-getSessionStorage('test'); // 123
-setLocalStorage('test', '123');
-getLocalStorage('test'); // 123
-
-// or package in usage
-const projectName = 'mazey';
-function mSetLocalStorage (key, value) {
-  return setLocalStorage(`${projectName}_${key}`, value);
-}
-
-function mGetLocalStorage (key) {
-  return getLocalStorage(`${projectName}_${key}`);
-}
-```
-
-#### Cookie
-
-Handle Cookie.
-
-```
-import { setCookie, getCookie } from 'mazey';
-
-setCookie('test', '123', 30, 'example.com'); // key value day domain
-getCookie('test'); // 123
-```
-
-### Calculate&Formula
-
-#### Rate
-
-Hit probability (1% ~ 100%).
-
-```
-import { inRate } from 'mazey';
-
-inRate(0.5); // 0.01 ~ 1 true / false
-
-// Test
-let trueCount = 0;
-let falseCount = 0;
-new Array(1000000).fill(0).forEach(() => {
-  if (inRate(0.5)) {
-    trueCount++;
-  } else {
-    falseCount++;
-  }
-});
-console.log(trueCount, falseCount); // 499994 500006
-```
-
-#### Algorithm
-
-Computes the longest common substring of two strings.
-
-```
-import { calLongestCommonSubstring } from 'mazey';
-
-calLongestCommonSubstring('fish', 'finish'); // 3
-```
-
-Computes the longest common subsequence of two strings.
-
-```
-import { calLongestCommonSubsequence } from 'mazey';
-
-calLongestCommonSubsequence('fish', 'finish'); // 4
-```
-
-### Browser Information
-
-```
-import { getBrowserInfo } from 'mazey';
-
-getBrowserInfo(); // {"engine":"webkit","engineVs":"537.36","platform":"desktop","supporter":"chrome","supporterVs":"85.0.4183.121","system":"windows","systemVs":"10"}
-// Shell and shell version { shell: 'wechat', shellVs: '20' } shell: wechat qq uc 360 2345 sougou liebao maxthon
-```
-
-| Index | Field | Description |
-| --- | --- | --- |
-| * System | system | android, ios, windows, macos, linux |
-| * System version | systemVs | windows: 2000, xp, 2003, vista, 7, 8, 8.1, 10<br />macos: ... |
-| * Platform | platform | desktop, mobile |
-| * Engine | engine | webkit, gecko, presto, trident |
-| * Engine version | engineVs | - |
-| * Supporter | supporter | edge, opera, chrome, safari, firefox, iexplore |
-| * Supporter version | supporterVs | - |
-| Shell | shell | wechat, qq_browser, qq_app, uc, 360, 2345, sougou, liebao, maxthon, bilibili |
-| Shell version | shellVs | - |
-| Apple device type | appleType | iphone, ipad, ipod, iwatch |
-
-### Web Performance
-
-Get page load time(PerformanceTiming).
-
-```
-import { getPerformance } from 'mazey';
-
-// `camelCase：true`(Default) Return hump data.
-// `camelCase：false` Return underline data.
-getPerformance(true)
- .then(res => {
-  console.log(JSON.stringify(res));
-  // {"deviceType":"pc","network":"3g","unloadTime":0,"redirectTime":0,"dnsTime":0,"tcpTime":0,"responseTime":65,"downloadTime":1,"domreadyTime":369,"onloadTime":441,"whiteTime":94,"renderTime":441,"decodedBodySize":210,"encodedBodySize":210}
- })
- .catch(console.error);
-```
-
-| Index | Field | Calculation |
-| --- | --- | --- |
-| * DNS lookup | dns_time | domainLookupEnd - domainLookupStart |
-| * Connection negotiation | tcp_time | connectEnd - connectStart |
-| * Requests and responses | response_time | responseStart - requestStart |
-| * White screen | white_time | responseStart - navigationStart |
-| * DomReady | domready_time  | domContentLoadedEventStart - navigationStart |
-| * Onload | onload_time | loadEventStart - navigationStart |
-| * EventEnd | render_time | loadEventEnd -navigationStart |
-| Unload | unload_time | unloadEventEnd - unloadEventStart |
-| Redirect | redirect_time | redirectEnd - redirectStart |
-| SSL | ssl_time | connectEnd - secureConnectionStart |
-| Download | download_time | responseEnd - responseStart |
-
-### Margin of Safety
-
-Determine if it is a secure PWA environment that it can run.
-
-```
-import { isSafePWAEnv } from 'mazey';
-
-isSafePWAEnv(); // true
-```
-
-### Debug
-
-#### Print
-
-Custom console printing (`console`).
-
-```
-import { genCustomConsole } from 'mazey';
-
-const myConsole = genCustomConsole('MazeyLog:');
-myConsole.log('I am string.'); // MazeyLog: I am string.
-myConsole.info('I am boolean.', true); // MazeyLog: I am boolean. true
-myConsole.info('I am number.', 123, 456); // MazeyLog: I am number. 123 456
-myConsole.info('I am object.', { a: 123, b: 456}); // MazeyLog: I am object. {a: 123, b: 456}
-```
-
-[More API>>](https://mazey.cn/docs/mazey/modules/_index_.html)
-
-## Develop
-
-```
-# dev
-npm run dev
-
-# build
-npm run build
-
-# documentation
-npm run docs
-```
+English | [简体中文](./README_CN.md)
+
+# mazey
+
+[![NPM version][npm-image]][npm-url]
+[![l][l-image]][l-url]
+
+[npm-image]: https://img.shields.io/npm/v/mazey
+[npm-url]: https://npmjs.org/package/mazey
+[l-image]: https://img.shields.io/npm/l/mazey
+[l-url]: https://github.com/mazeyqian/mazey
+
+Mazey's functional library for daily front-end work. There are already many excellent libraries for front-end development, but it's general to create a file named `utils.js` or `common.js` to supply common functions in projects. It's boring to copy similar functions among projects again and again. In order to save time, I will consistently update the library during my front-end career.
+
+## Install
+
+Use mazey via [npm](https://www.npmjs.com/package/mazey).
+
+```
+npm install mazey --save
+```
+
+Use mazey from CDN.
+
+```
+<script type="text/javascript" src="//i.mazey.net/mazey/lib/mazey.min.js"></script>
+```
+
+Of course, you can also download this file and serve it yourself.
+
+## Usage
+
+### Load Resource
+
+#### Load JavaScript
+
+Import from [npm](https://www.npmjs.com/package/mazey).
+
+```
+import { loadScript } from 'mazey';
+
+loadScript(
+    'http://example.com/js/plugin/jquery/jquery-2.1.1.min.js',
+    {
+      id: 'iamid', // Optional, script ID, default none
+      timeout: 5000, // Optional, timeout, default `5000`
+      isDefer: false, // Optional, defer, default `false`
+    }
+  )
+  .then(
+    res => {
+      console.log(`Load JavaScript Success: ${res}`);
+    }
+  )
+  .catch(
+    err => {
+      console.error(`Load JavaScript Fail: ${err.message}`)
+    }
+  );
+```
+
+Import from CDN.
+
+```
+<script type="text/javascript" src="//i.mazey.net/mazey/lib/mazey.min.js"></script>
+<script>
+mazey.loadScript(
+    'http://example.com/js/plugin/jquery/jquery-2.1.1.min.js',
+    {
+      id: 'iamid', // Optional, script ID, default none
+      timeout: 5000, // Optional, timeout, default `5000`
+      isDefer: false, // Optional, defer, default `false`
+    }
+  )
+  .then(
+    res => {
+      console.log(`Load JavaScript Success: ${res}`);
+    }
+  )
+  .catch(
+    err => {
+      console.error(`Load JavaScript Fail: ${err.message}`)
+    }
+  );
+</script>
+```
+
+#### Load CSS
+
+```
+import { loadCSS } from 'mazey';
+
+loadCSS(
+    'http://example.com/css/mazey-base.css',
+    {
+      id: 'iamid', // Optional, link ID, default none
+    }
+  )
+  .then(
+    res => {
+      console.log(`Load CSS Success: ${res}`);
+    }
+  )
+  .catch(
+    err => {
+      console.error(`Load CSS Fail: ${err.message}`)
+    }
+  );
+```
+
+#### Check Load
+
+Check whether the page is loaded successfully (Keepe the compatibility in case that browser's `load` event has been triggered).
+
+```
+import { windowLoaded } from 'mazey';
+
+windowLoaded(30) // second
+  .then(res => {
+    console.log(`Load Success: ${res}`); // Load Success: load
+  })
+  .catch(err => {
+    console.log(`Load Timeout or Fail: ${err.message}`);
+  });
+```
+### Function
+
+#### Debounce
+
+```
+import { debounce } from 'mazey';
+
+const foo = debounce(() => {
+  console.log('The debounced function will only be invoked in 1000 milliseconds, the other invoking will disappear during the wait time.');
+}, 1000, { leading: true })
+```
+
+#### Throttle
+
+```
+import { throttle } from 'mazey';
+
+const foo = throttle(() => {
+  console.log('The function will be invoked at most once per every wait 1000 milliseconds.');
+}, 1000, { leading: true })
+```
+
+#### Check Number
+
+Check whether it is a right number.
+
+```
+import { isNumber } from 'mazey';
+
+isNumber(123); // true
+isNumber('123'); // false
+// Default: NaN, Infinity is not Number
+isNumber(Infinity); // false
+isNumber(Infinity, { isUnFiniteAsNumber: true }); true
+isNumber(NaN); // false
+isNumber(NaN, { isNaNAsNumber: true, isUnFiniteAsNumber: true }); // true
+```
+
+#### Camel Case
+
+Transfer CamelCase to KebabCase.
+
+```
+import { camelCaseToKebabCase } from 'mazey';
+
+camelCaseToKebabCase('ABC'); // a-b-c
+camelCaseToKebabCase('aBC'); // a-b-c
+```
+
+Transfer CamelCase to Underscore.
+
+```
+import { camelCase2Underscore } from 'mazey';
+
+camelCase2Underscore('ABC'); // a_b_c
+camelCase2Underscore('aBC'); // a_b_c
+```
+
+#### Trim
+
+Remove leading and trailing whitespace or specified characters from string.
+
+```
+import { mTrim } from 'mazey';
+
+mTrim(' 1 2 3 '); // '1 2 3'
+mTrim('abc '); // 'abc'
+```
+
+#### Deep Clone
+
+Clone Object deeply.
+
+```
+import { deepCopyObject } from 'mazey';
+
+deepCopyObject(['a', 'b', 'c']); // ['a', 'b', 'c']
+deepCopyObject('abc'); // 'abc'
+```
+
+#### JSON
+
+Check whether it is a valid JSON string.
+
+```
+import { isJsonString } from 'mazey';
+
+isJsonString(`['a', 'b', 'c']`); // false
+isJsonString(`["a", "b", "c"]`); // true
+```
+
+#### Random
+
+Produce a random string of number, `generateRndNum(7)` => '7658495'.
+
+```
+import { generateRndNum } from 'mazey';
+
+generateRndNum(4); // '9730'
+generateRndNum(7); // '2262490'
+```
+
+### DOM
+
+#### Class
+
+Modify `class`.
+
+```
+import { hasClass, addClass, removeClass } from 'mazey';
+
+const dom = document.querySelector('#box');
+
+// Determine `class`
+hasClass(dom, 'test');
+// Add `class`
+addClass(dom, 'test');
+// Remove `class`
+removeClass(dom, 'test');
+```
+
+#### Style
+
+Add `<style>` in `<head>`.
+
+Case 1: Add the `<style>` with `id`, and repeated invoking will update the content instead of adding a new one.
+
+```
+import { addStyle } from 'mazey';
+
+addStyle(
+  `
+    body {
+      background-color: #333;
+    }
+  `,
+  {
+    id: 'test',
+  }
+);
+// <style id="test">
+//   body {
+//     background-color: #333;
+//   }
+// </style>
+```
+
+Case 2: Add the `<style>` without `id`, and repeated invoking will adding a new one.
+
+```
+import { addStyle } from 'mazey';
+
+addStyle(
+  `
+    body {
+      background-color: #444;
+    }
+  `
+);
+// <style>
+//   body {
+//     background-color: #444;
+//   }
+// </style>
+```
+
+#### Newline
+
+Make a newline of HTML.
+
+```
+import { newLine } from 'mazey';
+
+newLine('a\nb\nc'); // 'a<br />b<br />c'
+newLine('a\n\nbc'); // 'a<br /><br />bc'
+```
+
+### URL
+
+#### Query Param
+
+Get the query param's value of the current Web URL(`location.search`).
+
+```
+import { getQueryParam } from 'mazey';
+
+// http://example.com/?t1=1&t2=2&t3=3&t4=4#2333
+// ?t1=1&t2=2&t3=3&t4=4
+getQueryParam('t3'); // 3
+getQueryParam('t4'); // 4
+```
+
+Get the query param's value of the input URL.
+
+```
+import { getUrlParam } from 'mazey';
+
+getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3'); // 3
+getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4'); // 4
+```
+
+#### Update Param
+
+Update the query param's value of the input URL.
+
+```
+import { updateQueryParam } from 'mazey';
+
+updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3', 'three'); // http://example.com/?t1=1&t2=2&t3=three&t4=4
+updateQueryParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4', 'four'); // http://example.com/?t1=1&t2=2&t3=3&t4=four
+```
+
+#### Hash Param
+
+Get the hash query param's value of the current Web URL(`location.hash`).
+
+```
+import { getHashQueryParam } from 'mazey';
+
+// http://example.com/?#2333?t1=1&t2=2&t3=3&t4=4
+// #2333?t1=1&t2=2&t3=3&t4=4
+getHashQueryParam('t3'); // 3
+getHashQueryParam('t4'); // 4
+```
+
+#### Domain
+
+Get the domain of URL, and other params.
+
+```
+import { getDomain } from 'mazey';
+
+getDomain('http://example.com/?t1=1&t2=2&t3=3&t4=4'); // example.com
+getDomain('http://example.com/test/thanks?t1=1&t2=2&t3=3&t4=4', ['hostname', 'pathname']); // example.com/test/thanks
+```
+
+### Cache Data
+
+#### Storage
+
+Handle Storage (Keep fit for JSON, it can tansfer format automatically).
+
+```
+import { setSessionStorage, getSessionStorage, setLocalStorage, getLocalStorage } from 'mazey';
+
+setSessionStorage('test', '123');
+getSessionStorage('test'); // 123
+setLocalStorage('test', '123');
+getLocalStorage('test'); // 123
+
+// or package in usage
+const projectName = 'mazey';
+function mSetLocalStorage (key, value) {
+  return setLocalStorage(`${projectName}_${key}`, value);
+}
+
+function mGetLocalStorage (key) {
+  return getLocalStorage(`${projectName}_${key}`);
+}
+```
+
+#### Cookie
+
+Handle Cookie.
+
+```
+import { setCookie, getCookie } from 'mazey';
+
+setCookie('test', '123', 30, 'example.com'); // key value day domain
+getCookie('test'); // 123
+```
+
+### Calculate&Formula
+
+#### Rate
+
+Hit probability (1% ~ 100%).
+
+```
+import { inRate } from 'mazey';
+
+inRate(0.5); // 0.01 ~ 1 true / false
+
+// Test
+let trueCount = 0;
+let falseCount = 0;
+new Array(1000000).fill(0).forEach(() => {
+  if (inRate(0.5)) {
+    trueCount++;
+  } else {
+    falseCount++;
+  }
+});
+console.log(trueCount, falseCount); // 499994 500006
+```
+
+#### Algorithm
+
+Computes the longest common substring of two strings.
+
+```
+import { calLongestCommonSubstring } from 'mazey';
+
+calLongestCommonSubstring('fish', 'finish'); // 3
+```
+
+Computes the longest common subsequence of two strings.
+
+```
+import { calLongestCommonSubsequence } from 'mazey';
+
+calLongestCommonSubsequence('fish', 'finish'); // 4
+```
+
+### Browser Information
+
+```
+import { getBrowserInfo } from 'mazey';
+
+getBrowserInfo(); // {"engine":"webkit","engineVs":"537.36","platform":"desktop","supporter":"chrome","supporterVs":"85.0.4183.121","system":"windows","systemVs":"10"}
+// Shell and shell version { shell: 'wechat', shellVs: '20' } shell: wechat qq uc 360 2345 sougou liebao maxthon
+```
+
+| Index | Field | Description |
+| --- | --- | --- |
+| * System | system | android, ios, windows, macos, linux |
+| * System version | systemVs | windows: 2000, xp, 2003, vista, 7, 8, 8.1, 10<br />macos: ... |
+| * Platform | platform | desktop, mobile |
+| * Engine | engine | webkit, gecko, presto, trident |
+| * Engine version | engineVs | - |
+| * Supporter | supporter | edge, opera, chrome, safari, firefox, iexplore |
+| * Supporter version | supporterVs | - |
+| Shell | shell | wechat, qq_browser, qq_app, uc, 360, 2345, sougou, liebao, maxthon, bilibili |
+| Shell version | shellVs | - |
+| Apple device type | appleType | iphone, ipad, ipod, iwatch |
+
+### Web Performance
+
+Get page load time(PerformanceTiming).
+
+```
+import { getPerformance } from 'mazey';
+
+// `camelCase：true`(Default) Return hump data.
+// `camelCase：false` Return underline data.
+getPerformance(true)
+ .then(res => {
+  console.log(JSON.stringify(res));
+  // {"deviceType":"pc","network":"3g","unloadTime":0,"redirectTime":0,"dnsTime":0,"tcpTime":0,"responseTime":65,"downloadTime":1,"domreadyTime":369,"onloadTime":441,"whiteTime":94,"renderTime":441,"decodedBodySize":210,"encodedBodySize":210}
+ })
+ .catch(console.error);
+```
+
+| Index | Field | Calculation |
+| --- | --- | --- |
+| * DNS lookup | dns_time | domainLookupEnd - domainLookupStart |
+| * Connection negotiation | tcp_time | connectEnd - connectStart |
+| * Requests and responses | response_time | responseStart - requestStart |
+| * White screen | white_time | responseStart - navigationStart |
+| * DomReady | domready_time  | domContentLoadedEventStart - navigationStart |
+| * Onload | onload_time | loadEventStart - navigationStart |
+| * EventEnd | render_time | loadEventEnd -navigationStart |
+| Unload | unload_time | unloadEventEnd - unloadEventStart |
+| Redirect | redirect_time | redirectEnd - redirectStart |
+| SSL | ssl_time | connectEnd - secureConnectionStart |
+| Download | download_time | responseEnd - responseStart |
+
+### Margin of Safety
+
+Determine if it is a secure PWA environment that it can run.
+
+```
+import { isSafePWAEnv } from 'mazey';
+
+isSafePWAEnv(); // true
+```
+
+### Debug
+
+#### Print
+
+Custom console printing (`console`).
+
+```
+import { genCustomConsole } from 'mazey';
+
+const myConsole = genCustomConsole('MazeyLog:');
+myConsole.log('I am string.'); // MazeyLog: I am string.
+myConsole.info('I am boolean.', true); // MazeyLog: I am boolean. true
+myConsole.info('I am number.', 123, 456); // MazeyLog: I am number. 123 456
+myConsole.info('I am object.', { a: 123, b: 456}); // MazeyLog: I am object. {a: 123, b: 456}
+```
+
+[More API>>](https://mazey.cn/docs/mazey/modules/_index_.html)
+
+## Develop
+
+```
+# dev
+npm run dev
+
+# build
+npm run build
+
+# documentation
+npm run docs
+```