mazey 3.7.4 → 3.8.1

package/README.md

@@ -63,20 +63,21 @@ There ara some examples maintained by hand below. For more information, please c
 - Generated with ❤️
 - [Load Resource](#load-resource)
   * [loadScript](#loadscript)
+  * [loadScriptIfUndefined](#loadscriptifundefined)
   * [loadCSS](#loadcss)
+  * [loadImage](#loadimage)
   * [windowLoaded](#windowloaded)
 - [Util](#util)
   * [isNumber](#isnumber)
   * [isJSONString](#isjsonstring)
   * [isValidData](#isvaliddata)
-  * [generateRndNum](#generaterndnum)
+  * [genRndNumString](#genrndnumstring)
   * [formatDate](#formatdate)
   * [debounce](#debounce)
   * [throttle](#throttle)
   * [convertCamelToKebab](#convertcameltokebab)
   * [convertCamelToUnder](#convertcameltounder)
-  * [deepCopyObject](#deepcopyobject)
-  * [mTrim](#mtrim)
+  * [deepCopy](#deepcopy)
 - [URL](#url)
   * [getQueryParam](#getqueryparam)
   * [getUrlParam](#geturlparam)
@@ -92,8 +93,8 @@ There ara some examples maintained by hand below. For more information, please c
   * [newLine](#newline)
 - [Calculate and Formula](#calculate-and-formula)
   * [inRate](#inrate)
-  * [calLongestCommonSubstring](#callongestcommonsubstring)
-  * [calLongestCommonSubsequence](#callongestcommonsubsequence)
+  * [longestComSubstring](#longestcomsubstring)
+  * [longestComSubsequence](#longestcomsubsequence)
 - [Browser Information](#browser-information)
   * [getBrowserInfo](#getbrowserinfo)
   * [isSafePWAEnv](#issafepwaenv)
@@ -140,6 +141,20 @@ loadScript(
 @returns {Promise<boolean>} -- true 成功
 @category Load Resource -->
 
+#### loadScriptIfUndefined
+
+Load a script from the given URL if it (`window['attribute']`) has not already been loaded.
+
+```js
+loadScriptIfUndefined('jQuery', 'https://example.com/lib/jquery.min.js')
+  .then(() => {
+    console.log('jQuery is loaded.');
+  })
+  .catch(err => {
+    console.log('Failed to load jQuery.', err);
+  });
+```
+
 #### loadCSS
 
 Load a CSS file from the server.
@@ -170,6 +185,24 @@ loadCSS(
 @returns {Promise<boolean>} true -- 加载成功
 @category Load Resource -->
 
+#### loadImage
+
+Load an image from the given URL.
+
+The target image will be loaded in the background, and the Promise status will change after the image is loaded. If the image fails to load, the Promise status will change to `reject` with the error object. If the image is loaded successfully, the Promise status will change to `resolve` with the image object. This method can be used to preload images and cache them in the browser. It can also be used to implement lazy loading of images.
+
+Note that this method will not add the image to the DOM.
+
+```js
+loadImage('https://example.com/example.png')
+  .then((img) => {
+    console.log(img);
+  })
+  .catch((err) => {
+    console.log(err);
+  });
+```
+
 #### windowLoaded
 
 Check whether the page is loaded successfully (Keepe the compatibility in case that browser's `load` event has been triggered).
@@ -274,19 +307,15 @@ isValidDataResC: false
 @returns {boolean} Return TRUE if the data is valid.
 @category Util -->
 
-#### generateRndNum
+#### genRndNumString
 
-Produce a random string of number, `generateRndNum(7)` => '7658495'.
+Produce a random string of number, `genRndNumString(7)` => '7658495'.
 
 ```
-generateRndNum(4); // '9730'
-generateRndNum(7); // '2262490'
+genRndNumString(4); // '9730'
+genRndNumString(7); // '2262490'
 ```
 
-<!-- @param {number} n Length
-@returns {string} Return the random string.
-@category Util -->
-
 #### formatDate
 
 Return the formatted date string in the given format.
@@ -370,15 +399,15 @@ convertCamelToUnder('aBC'); // a_b_c
 @returns {string} 'a_b_c'
 @category Util -->
 
-#### deepCopyObject
+#### deepCopy
 
-Clone Object deeply.
+Copy/Clone Object deeply.
 
 Usage:
 
 ```
-deepCopyObject(['a', 'b', 'c']);
-deepCopyObject('abc');
+deepCopy(['a', 'b', 'c']);
+deepCopy('abc');
 ```
 
 Output:
@@ -388,23 +417,6 @@ Output:
 'abc'
 ```
 
-<!-- @param {object} obj The value to clone.
-@returns {object} Returns the deep cloned value.
-@category Util -->
-
-#### mTrim
-
-Remove leading and trailing whitespace or specified characters from string.
-
-```
-mTrim(' 1 2 3 '); // '1 2 3'
-mTrim('abc '); // 'abc'
-```
-
-<!-- @param {string} str The string to trim.
-@returns {string} Trimmed string.
-@category Util -->
-
 ### URL
 
 #### getQueryParam
@@ -673,16 +685,14 @@ console.log(trueCount, falseCount); // 499994 500006
 @returns {boolean} true 命中
 @category Calculate and Formula -->
 
-#### calLongestCommonSubstring
+#### longestComSubstring
 
 Computes the longest common substring of two strings.
 
-<!-- ZH: 计算两个字符串的最长公共子串 -->
-
 Usage:
 
 ```
-calLongestCommonSubstring('fish', 'finish');
+longestComSubstring('fish', 'finish');
 ```
 
 Output:
@@ -691,21 +701,14 @@ Output:
 3
 ```
 
-<!-- @param {string} aStr String
-@param {string} bStr String
-@returns {number} Length
-@category Calculate and Formula -->
-
-#### calLongestCommonSubsequence
+#### longestComSubsequence
 
 Computes the longest common subsequence of two strings.
 
-<!-- ZH: 计算两个字符串的最长公共子序列 -->
-
 Usage:
 
 ```
-calLongestCommonSubsequence('fish', 'finish');
+longestComSubsequence('fish', 'finish');
 ```
 
 Output:
@@ -714,11 +717,6 @@ Output:
 4
 ```
 
-<!-- @param {string} aStr 字符串
-@param {string} bStr 字符串
-@returns {number} 长度
-@category Calculate and Formula -->
-
 ### Browser Information
 
 #### getBrowserInfo
@@ -884,6 +882,19 @@ npm run docs
 npm run test
 ```
 
+Returns:
+
+| Values    | Description                              | Type    |
+| :-------- | :--------------------------------------- | :------ |
+| ok        | The operation was successful.            | string  |
+| loaded    | Some assets have been loaded.            | string  |
+| fail      | An error occurred.                       | string  |
+| defined   | The value is defined.                    | string  |
+| undefined | The value is undefined.                  | string  |
+| timeout   | The operation timed out.                 | string  |
+| true      | The value is true.                       | boolean |
+| false     | The value is false.                      | boolean |
+
 ## License
 
 This software is released under the terms of the [MIT license](https://github.com/mazeyqian/mazey/blob/master/LICENSE).