docs: 更新文档

doly-dev · Jun 7, 2021 · 639323b · 639323b
1 parent d40bd1b
commit 639323b
Show file tree

Hide file tree

Showing 36 changed files with 109 additions and 62 deletions.
diff --git a/docs/bytesToSize.js.html b/docs/bytesToSize.js.html
@@ -102,7 +102,7 @@ <h1 class="page-title">bytesToSize.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/divide.js.html b/docs/divide.js.html
@@ -65,9 +65,9 @@ <h1 class="page-title">divide.js</h1>
  * @static
  * @alias module:Math.divide
  * @since 3.1.0
- * @param {number} num1 除数
- * @param {number} num2 被除数
- * @param {...number} others 其余被除数
+ * @param {number|string} num1 除数
+ * @param {number|string} num2 被除数
+ * @param {...number|string} others 其余被除数
  * @returns {number} 商数
  * @example
  * 
@@ -107,7 +107,7 @@ <h1 class="page-title">divide.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/formatBankCard.js.html b/docs/formatBankCard.js.html
@@ -116,7 +116,7 @@ <h1 class="page-title">formatBankCard.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/formatMoney.js.html b/docs/formatMoney.js.html
@@ -222,7 +222,7 @@ <h1 class="page-title">formatMoney.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -253,7 +253,7 @@ <h3>commit 格式</h3>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -129,7 +129,7 @@ <h1 class="page-title">index.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isBankCard.js.html b/docs/isBankCard.js.html
@@ -111,7 +111,7 @@ <h1 class="page-title">isBankCard.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isBusinessLicense.js.html b/docs/isBusinessLicense.js.html
@@ -56,7 +56,9 @@ <h1 class="page-title">isBusinessLicense.js</h1>
 
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>// 基础规则，由14位数字本体码和1位数字校验码组成，其中本体码从左至右依次为：6位首次登记机关码、8位顺序码。
+            <pre class="prettyprint source linenums"><code>import isString from './utils/type/isString';
+
+// 基础规则，由14位数字本体码和1位数字校验码组成，其中本体码从左至右依次为：6位首次登记机关码、8位顺序码。
 const baseReg = /^\d{15}$/;
 
 /**
@@ -121,17 +123,19 @@ <h1 class="page-title">isBusinessLicense.js</h1>
 function isBusinessLicense(value, {
   loose = false
 } = {}) {
-  const passBaseRule = baseReg.test(value);
+  const realValue = isString(value) ? value : String(value);
+
+  const passBaseRule = baseReg.test(realValue);
 
   // 宽松模式 或 基础规则不通过直接返回
   if (loose || !passBaseRule) {
     return passBaseRule;
   }
 
   // 前14位
-  const preCode = value.substr(0, 14);
+  const preCode = realValue.substr(0, 14);
   // 校验码
-  const lastCode = value.substr(-1);
+  const lastCode = realValue.substr(-1);
   // 计算校验码
   const checkCode = sumCheckCode(preCode);
 
@@ -152,7 +156,7 @@ <h1 class="page-title">isBusinessLicense.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isChinese.js.html b/docs/isChinese.js.html
@@ -157,7 +157,7 @@ <h1 class="page-title">isChinese.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isEmail.js.html b/docs/isEmail.js.html
@@ -94,7 +94,7 @@ <h1 class="page-title">isEmail.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isIPv4.js.html b/docs/isIPv4.js.html
@@ -100,7 +100,7 @@ <h1 class="page-title">isIPv4.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isIPv6.js.html b/docs/isIPv6.js.html
@@ -125,7 +125,7 @@ <h1 class="page-title">isIPv6.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isIdCard.js.html b/docs/isIdCard.js.html
@@ -100,7 +100,7 @@ <h1 class="page-title">isIdCard.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isMobile.js.html b/docs/isMobile.js.html
@@ -94,7 +94,7 @@ <h1 class="page-title">isMobile.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isPassport.js.html b/docs/isPassport.js.html
@@ -96,7 +96,7 @@ <h1 class="page-title">isPassport.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isPassword.js.html b/docs/isPassword.js.html
@@ -120,7 +120,7 @@ <h1 class="page-title">isPassword.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isPostcode.js.html b/docs/isPostcode.js.html
@@ -94,7 +94,7 @@ <h1 class="page-title">isPostcode.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isPromiseLike.js.html b/docs/isPromiseLike.js.html
@@ -97,7 +97,7 @@ <h1 class="page-title">isPromiseLike.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isQQ.js.html b/docs/isQQ.js.html
@@ -94,7 +94,7 @@ <h1 class="page-title">isQQ.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isSocialCreditCode.js.html b/docs/isSocialCreditCode.js.html
@@ -56,7 +56,9 @@ <h1 class="page-title">isSocialCreditCode.js</h1>
 
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>// 基础规则，由18位数字和大写字母组成，不使用I、O、Z、S、V。
+            <pre class="prettyprint source linenums"><code>import isString from './utils/type/isString';
+
+// 基础规则，由18位数字和大写字母组成，不使用I、O、Z、S、V。
 const baseReg = /^[\dA-HJ-NPQRTUWXY]{2}\d{6}[\dA-HJ-NPQRTUWXY]{10}$/;
 
 // 基础字符组成
@@ -145,17 +147,19 @@ <h1 class="page-title">isSocialCreditCode.js</h1>
 function isSocialCreditCode(value, {
   loose = false
 } = {}) {
-  const passBaseRule = baseReg.test(value);
+  const realValue = isString(value) ? value : String(value);
+
+  const passBaseRule = baseReg.test(realValue);
 
   // 宽松模式 或 基础规则不通过直接返回
   if (loose || !passBaseRule) {
     return passBaseRule;
   }
 
   // 前17位
-  const preCode = value.substr(0, 17);
+  const preCode = realValue.substr(0, 17);
   // 校验码
-  const lastCode = value.substr(-1);
+  const lastCode = realValue.substr(-1);
   // 计算校验码
   const checkCode = sumCheckCode(preCode);
 
@@ -176,7 +180,7 @@ <h1 class="page-title">isSocialCreditCode.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isTelephone.js.html b/docs/isTelephone.js.html
@@ -100,7 +100,7 @@ <h1 class="page-title">isTelephone.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isUrl.js.html b/docs/isUrl.js.html
@@ -109,7 +109,7 @@ <h1 class="page-title">isUrl.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isVehicle.js.html b/docs/isVehicle.js.html
@@ -104,7 +104,7 @@ <h1 class="page-title">isVehicle.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/isWX.js.html b/docs/isWX.js.html
@@ -94,7 +94,7 @@ <h1 class="page-title">isWX.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/minus.js.html b/docs/minus.js.html
@@ -65,9 +65,9 @@ <h1 class="page-title">minus.js</h1>
  * @static
  * @alias module:Math.minus
  * @since 3.1.0
- * @param {number} num1 相减的第一个数
- * @param {number} num2 相减的第二个数
- * @param {...number} others 相减的第其余数
+ * @param {number|string} num1 相减的第一个数
+ * @param {number|string} num2 相减的第二个数
+ * @param {...number|string} others 相减的第其余数
  * @returns {number} 差
  * @example
  * 
@@ -103,7 +103,7 @@ <h1 class="page-title">minus.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 24 2021 16:20:26 GMT+0800 (GMT+08:00) 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.6</a> on Mon Jun 07 2021 19:39:38 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>