mazey 3.6.2 → 3.6.4

package/README.md

@@ -1,4 +1,4 @@
-English | [简体中文](https://github.com/mazeyqian/mazey/blob/master/README_CN.md)
+English | [简体中文](https://github.com/mazeyqian/mazey/blob/master/README_ZH.md)
 
 # mazey
 
@@ -10,7 +10,7 @@ English | [简体中文](https://github.com/mazeyqian/mazey/blob/master/README_C
 [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 creating a file named UtilsJS or CommonJS is generally used to supply common functions in projects. It's boring to copy similar functions among projects again and again. Therefore, I will consistently update the library during my work life to save time.
+Mazey's functional library for daily front-end work. There are already many excellent libraries for front-end development, but creating a file named `utils.js` or `common.js` is generally used to supply common functions in projects. It's boring to copy similar functions across multiple projects. That's why I've created this library and will keep updating it to serve as a reliable resource for front-end needs.
 
 ## Install
 
@@ -37,7 +37,9 @@ Import from [npm](https://www.npmjs.com/package/mazey).
 ```
 import { isNumber } from 'mazey';
 
-isNumber(Infinity, { isUnFiniteAsNumber: true }); // true
+const x = Infinity;
+isNumber(x); // <=> typeof x === 'string' && !isNaN(x) && isFinite(x)
+// Output: false
 ```
 
 Import from CDN.
@@ -45,7 +47,9 @@ Import from CDN.
 ```
 <script type="text/javascript" src="//i.mazey.net/mazey/lib/mazey.min.js"></script>
 <script>
-  mazey.isNumber(Infinity, { isUnFiniteAsNumber: true }); // true
+  const x = Infinity;
+  mazey.isNumber(x, { isUnFiniteAsNumber: true }); // <=> typeof x === 'string' && !isNaN(x)
+  // Output: true
 </script>
 ```
 
@@ -63,14 +67,14 @@ There ara some examples maintained by hand below. For more information, please c
   * [windowLoaded](#windowloaded)
 - [Util](#util)
   * [isNumber](#isnumber)
-  * [isJsonString](#isjsonstring)
+  * [isJSONString](#isjsonstring)
   * [isValidData](#isvaliddata)
   * [generateRndNum](#generaterndnum)
   * [formatDate](#formatdate)
   * [debounce](#debounce)
   * [throttle](#throttle)
-  * [camelCaseToKebabCase](#camelcasetokebabcase)
-  * [camelCase2Underscore](#camelcase2underscore)
+  * [convertCamelToKebab](#convertcameltokebab)
+  * [convertCamelToUnder](#convertcameltounder)
   * [deepCopyObject](#deepcopyobject)
   * [mTrim](#mtrim)
 - [URL](#url)
@@ -210,15 +214,15 @@ isNumber(NaN, { isNaNAsNumber: true, isUnFiniteAsNumber: true }); // true
 @returns {boolean} true 是数字
 @category Util -->
 
-#### isJsonString
+#### isJSONString
 
 Check whether it is a valid JSON string.
 
 Usage:
 
 ```
-isJsonString(`['a', 'b', 'c']`);
-isJsonString(`["a", "b", "c"]`);
+isJSONString(`['a', 'b', 'c']`);
+isJSONString(`["a", "b", "c"]`);
 ```
 
 Output:
@@ -340,26 +344,26 @@ Reference: [Lodash](https://lodash.com/docs/4.17.15#throttle)
 
 <!-- @category Util -->
 
-#### camelCaseToKebabCase
+#### convertCamelToKebab
 
 Transfer CamelCase to KebabCase.
 
 ```
-camelCaseToKebabCase('ABC'); // a-b-c
-camelCaseToKebabCase('aBC'); // a-b-c
+convertCamelToKebab('ABC'); // a-b-c
+convertCamelToKebab('aBC'); // a-b-c
 ```
 
 <!-- @param {string} camelCase 'aBC' or 'ABC'
 @returns {string} 'a-b-c'
 @category Util -->
 
-#### camelCase2Underscore
+#### convertCamelToUnder
 
 Transfer CamelCase to Underscore.
 
 ```
-camelCase2Underscore('ABC'); // a_b_c
-camelCase2Underscore('aBC'); // a_b_c
+convertCamelToUnder('ABC'); // a_b_c
+convertCamelToUnder('aBC'); // a_b_c
 ```
 
 <!-- @param {string} camelCase 'aBC' or 'ABC'
@@ -465,6 +469,10 @@ Usage:
 ```
 getDomain('http://example.com/?t1=1&t2=2&t3=3&t4=4');
 getDomain('http://example.com/test/thanks?t1=1&t2=2&t3=3&t4=4', ['hostname', 'pathname']);
+getDomain('http://example.com:7890/test/thanks', ['hostname']);
+getDomain('http://example.com:7890/test/thanks', ['host']); // With Port
+getDomain('http://example.com:7890/test/thanks', ['origin']);
+getDomain('http://example.com:7890/test/thanks?id=1', ['origin', 'pathname', 'search']);
 ```
 
 Output:
@@ -472,10 +480,14 @@ Output:
 ```
 example.com
 example.com/test/thanks
+example.com
+example.com:7890
+http://example.com:7890
+http://example.com:7890/test/thanks?id=1
 ```
 
 <!-- @param {string} url
-@param {array} rules Object.keys(location), ['href', 'protocol', 'host', 'hostname', 'port', 'pathname', 'search', 'hash'], ['hostname', 'pathname'] = 'km.mazey.net/plugins/servlet/mobile'
+@param {array} rules Object.keys(location), ['href', 'origin', 'protocol', 'host', 'hostname', 'port', 'pathname', 'search', 'hash'], ['hostname', 'pathname'] = 'km.mazey.net/plugins/servlet/mobile'
 @category URL -->
 
 #### updateQueryParam
@@ -730,7 +742,7 @@ Output:
 Results:
 
 | Attribute | Description | Type | Values |
-| --- | --- | --- | --- |
+| :------------ | :------------ | :------------ | :------------ |
 | **system** | System | string | android, ios, windows, macos, linux |
 | systemVs | System version | string | windows: 2000, xp, 2003, vista, 7, 8, 8.1, 10 <br />macos: ... |
 | platform | Platform | string | desktop, mobile |
@@ -801,19 +813,19 @@ Output:
 
 Results:
 
-| Index | Field | Description |
-| --- | --- | --- |
-| 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 | (Optional) unloadEventEnd - unloadEventStart |
-| Redirect | redirect_time | (Optional) redirectEnd - redirectStart |
-| SSL | ssl_time | (Optional) connectEnd - secureConnectionStart |
-| Download | download_time | (Optional) responseEnd - responseStart |
+| Attribute | Description | Type | Values |
+| :------------ | :------------ | :------------ | :------------ |
+| dns_time | DNS Lookup | number | domainLookupEnd - domainLookupStart |
+| tcp_time | Connection Negotiation | number | connectEnd - connectStart |
+| response_time | Requests and Responses | number | responseStart - requestStart |
+| white_time | White Screen | number | responseStart - navigationStart |
+| domready_time | DomReady | number | domContentLoadedEventStart - navigationStart |
+| onload_time | Onload | number | loadEventStart - navigationStart |
+| render_time | EventEnd | number | loadEventEnd -navigationStart |
+| unload_time | Unload | number | (Optional) unloadEventEnd - unloadEventStart |
+| redirect_time | Redirect | number | (Optional) redirectEnd - redirectStart |
+| ssl_time | SSL | number | (Optional) connectEnd - secureConnectionStart |
+| download_time | Download | number | (Optional) responseEnd - responseStart |
 
 <!-- @param {boolean} camelCase -- false（默认） 以下划线形式返回数据 true 以驼峰形式返回数据
 @returns {Promise<object>} 加载数据