Feat: 完善注释

pandaoh · Jan 9, 2024 · 53cb0eb · 53cb0eb
1 parent 9727623
commit 53cb0eb
Show file tree

Hide file tree

Showing 11 changed files with 26 additions and 26 deletions.
diff --git a/dist/Form/index.d.ts b/dist/Form/index.d.ts
@@ -21,7 +21,7 @@ export declare function toFormData(obj: any, hasBrackets?: boolean, hasIndex?: b
  */
 export declare function toQueryString(obj: any, hasBrackets?: boolean, hasIndex?: boolean): URLSearchParams;
 /**
- * 创建用于处理表单数据的钩子函数
+ * 创建用于处理数据的钩子函数
  * @example
  * const [getData, setData, resetData] = useStateData({a: 1, b: 2, c: 3});
  * console.log(getData()); /// {a: 1, b: 2, c: 3}

diff --git a/dist/index.source.js b/dist/index.source.js
@@ -12346,7 +12346,7 @@
         return queryString;
     }
     /**
-     * 创建用于处理表单数据的钩子函数
+     * 创建用于处理数据的钩子函数
      * @example
      * const [getData, setData, resetData] = useStateData({a: 1, b: 2, c: 3});
      * console.log(getData()); /// {a: 1, b: 2, c: 3}
@@ -12362,22 +12362,22 @@
     function useStateData(initialData) {
         var data = initialData;
         /**
-         * 设置表单数据
+         * 设置数据
          * @param value 新的数据
          */
         function setData(value) {
             data = value;
             return data;
         }
         /**
-         * 重置表单数据为初始值
+         * 重置数据为初始值
          */
         function resetData() {
             data = initialData;
             return data;
         }
         /**
-         * 获取数据值
+         * 获取数据
          */
         function getData() {
             return data;

diff --git a/docs/README.md b/docs/README.md
@@ -6924,7 +6924,7 @@ ___
 
 ▸ **useStateData**(`initialData`): (`value`: `any`) => `any`[]
 
-创建用于处理表单数据的钩子函数
+创建用于处理数据的钩子函数
 
 **`Example`**
 

diff --git a/es/Form/index.d.ts b/es/Form/index.d.ts
@@ -21,7 +21,7 @@ export declare function toFormData(obj: any, hasBrackets?: boolean, hasIndex?: b
  */
 export declare function toQueryString(obj: any, hasBrackets?: boolean, hasIndex?: boolean): URLSearchParams;
 /**
- * 创建用于处理表单数据的钩子函数
+ * 创建用于处理数据的钩子函数
  * @example
  * const [getData, setData, resetData] = useStateData({a: 1, b: 2, c: 3});
  * console.log(getData()); /// {a: 1, b: 2, c: 3}

diff --git a/es/index.source.js b/es/index.source.js
@@ -12340,7 +12340,7 @@ function toQueryString(obj, hasBrackets, hasIndex) {
     return queryString;
 }
 /**
- * 创建用于处理表单数据的钩子函数
+ * 创建用于处理数据的钩子函数
  * @example
  * const [getData, setData, resetData] = useStateData({a: 1, b: 2, c: 3});
  * console.log(getData()); /// {a: 1, b: 2, c: 3}
@@ -12356,22 +12356,22 @@ function toQueryString(obj, hasBrackets, hasIndex) {
 function useStateData(initialData) {
     var data = initialData;
     /**
-     * 设置表单数据
+     * 设置数据
      * @param value 新的数据
      */
     function setData(value) {
         data = value;
         return data;
     }
     /**
-     * 重置表单数据为初始值
+     * 重置数据为初始值
      */
     function resetData() {
         data = initialData;
         return data;
     }
     /**
-     * 获取数据值
+     * 获取数据
      */
     function getData() {
         return data;

diff --git a/html/functions/useStateData.html b/html/functions/useStateData.html
@@ -19,7 +19,7 @@ <h1>Function useStateData</h1></div>
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="useStateData"><span class="tsd-kind-call-signature">use<wbr/>State<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">initialData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><a href="#useStateData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>创建用于处理表单数据的钩子函数</p>
+<div class="tsd-comment tsd-typography"><p>创建用于处理数据的钩子函数</p>
 
 <h3>Example</h3><pre><code class="language-ts"><span class="hl-0">const</span><span class="hl-1"> [</span><span class="hl-2">getData</span><span class="hl-1">, </span><span class="hl-2">setData</span><span class="hl-1">, </span><span class="hl-2">resetData</span><span class="hl-1">] = </span><span class="hl-3">useStateData</span><span class="hl-1">({</span><span class="hl-4">a:</span><span class="hl-1"> </span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-4">b:</span><span class="hl-1"> </span><span class="hl-7">2</span><span class="hl-1">, </span><span class="hl-4">c:</span><span class="hl-1"> </span><span class="hl-7">3</span><span class="hl-1">});</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-3">getData</span><span class="hl-1">()); </span><span class="hl-5">/// {a: 1, b: 2, c: 3}</span><br/><span class="hl-3">setData</span><span class="hl-1">({ </span><span class="hl-4">a :</span><span class="hl-1"> </span><span class="hl-7">10</span><span class="hl-1"> }); </span><span class="hl-5">/// {a: 10}</span><br/><span class="hl-3">resetData</span><span class="hl-1">(); </span><span class="hl-5">/// {a: 1, b: 2, c: 3}</span><br/><span class="hl-0">const</span><span class="hl-1"> [</span><span class="hl-2">getData</span><span class="hl-1">, </span><span class="hl-2">setData</span><span class="hl-1">, </span><span class="hl-2">resetData</span><span class="hl-1">] = </span><span class="hl-3">useStateData</span><span class="hl-1">(</span><span class="hl-6">&#39;test&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-3">getData</span><span class="hl-1">()); </span><span class="hl-5">/// &#39;test&#39;</span><br/><span class="hl-3">setData</span><span class="hl-1">(</span><span class="hl-6">&#39;test001&#39;</span><span class="hl-1">); </span><span class="hl-5">/// &#39;test001&#39;</span><br/><span class="hl-3">resetData</span><span class="hl-1">(); </span><span class="hl-5">/// &#39;test&#39;</span>
 </code><button>Copy</button></pre>

diff --git a/iife/Form/index.d.ts b/iife/Form/index.d.ts
@@ -21,7 +21,7 @@ export declare function toFormData(obj: any, hasBrackets?: boolean, hasIndex?: b
  */
 export declare function toQueryString(obj: any, hasBrackets?: boolean, hasIndex?: boolean): URLSearchParams;
 /**
- * 创建用于处理表单数据的钩子函数
+ * 创建用于处理数据的钩子函数
  * @example
  * const [getData, setData, resetData] = useStateData({a: 1, b: 2, c: 3});
  * console.log(getData()); /// {a: 1, b: 2, c: 3}

diff --git a/iife/index.source.js b/iife/index.source.js
@@ -12343,7 +12343,7 @@ var $xxx = (function (exports) {
         return queryString;
     }
     /**
-     * 创建用于处理表单数据的钩子函数
+     * 创建用于处理数据的钩子函数
      * @example
      * const [getData, setData, resetData] = useStateData({a: 1, b: 2, c: 3});
      * console.log(getData()); /// {a: 1, b: 2, c: 3}
@@ -12359,22 +12359,22 @@ var $xxx = (function (exports) {
     function useStateData(initialData) {
         var data = initialData;
         /**
-         * 设置表单数据
+         * 设置数据
          * @param value 新的数据
          */
         function setData(value) {
             data = value;
             return data;
         }
         /**
-         * 重置表单数据为初始值
+         * 重置数据为初始值
          */
         function resetData() {
             data = initialData;
             return data;
         }
         /**
-         * 获取数据值
+         * 获取数据
          */
         function getData() {
             return data;

diff --git a/lib/Form/index.d.ts b/lib/Form/index.d.ts
@@ -21,7 +21,7 @@ export declare function toFormData(obj: any, hasBrackets?: boolean, hasIndex?: b
  */
 export declare function toQueryString(obj: any, hasBrackets?: boolean, hasIndex?: boolean): URLSearchParams;
 /**
- * 创建用于处理表单数据的钩子函数
+ * 创建用于处理数据的钩子函数
  * @example
  * const [getData, setData, resetData] = useStateData({a: 1, b: 2, c: 3});
  * console.log(getData()); /// {a: 1, b: 2, c: 3}

diff --git a/lib/index.source.js b/lib/index.source.js
@@ -12344,7 +12344,7 @@ function toQueryString(obj, hasBrackets, hasIndex) {
     return queryString;
 }
 /**
- * 创建用于处理表单数据的钩子函数
+ * 创建用于处理数据的钩子函数
  * @example
  * const [getData, setData, resetData] = useStateData({a: 1, b: 2, c: 3});
  * console.log(getData()); /// {a: 1, b: 2, c: 3}
@@ -12360,22 +12360,22 @@ function toQueryString(obj, hasBrackets, hasIndex) {
 function useStateData(initialData) {
     var data = initialData;
     /**
-     * 设置表单数据
+     * 设置数据
      * @param value 新的数据
      */
     function setData(value) {
         data = value;
         return data;
     }
     /**
-     * 重置表单数据为初始值
+     * 重置数据为初始值
      */
     function resetData() {
         data = initialData;
         return data;
     }
     /**
-     * 获取数据值
+     * 获取数据
      */
     function getData() {
         return data;

diff --git a/src/Form/index.ts b/src/Form/index.ts
@@ -63,7 +63,7 @@ export function toQueryString(obj: any, hasBrackets = false, hasIndex = false):
 }
 
 /**
- * 创建用于处理表单数据的钩子函数
+ * 创建用于处理数据的钩子函数
  * @example
  * const [getData, setData, resetData] = useStateData({a: 1, b: 2, c: 3});
  * console.log(getData()); /// {a: 1, b: 2, c: 3}
@@ -80,7 +80,7 @@ export function useStateData(initialData: any) {
   let data = initialData;
 
   /**
-   * 设置表单数据
+   * 设置数据
    * @param value 新的数据
    */
   function setData(value: any) {
@@ -89,15 +89,15 @@ export function useStateData(initialData: any) {
   }
 
   /**
-   * 重置表单数据为初始值
+   * 重置数据为初始值
    */
   function resetData() {
     data = initialData;
     return data;
   }
 
   /**
-   * 获取数据值
+   * 获取数据
    */
   function getData() {
     return data;