npm - w-data-csv - Versions diffs - 1.0.19 → 1.0.21 - Mend

w-data-csv 1.0.19 → 1.0.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/dist/w-data-csv.umd.js +2 -2
package/dist/w-data-csv.umd.js.map +1 -1
package/docs/WDataCsv.mjs.html +124 -40
package/docs/global.html +1174 -74
package/docs/index.html +1 -1
package/package.json +2 -2
package/src/WDataCsv.mjs +123 -39
package/test/readOpt.test.mjs +143 -0

package/docs/global.html CHANGED Viewed

@@ -140,7 +140,7 @@
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="WDataCsv.mjs.html">WDataCsv.mjs</a>, <a href="WDataCsv.mjs.html#line279">line 279</a>
+        <a href="WDataCsv.mjs.html">WDataCsv.mjs</a>, <a href="WDataCsv.mjs.html#line363">line 363</a>
     </li></ul></dd>
@@ -206,7 +206,7 @@
-    <h4 class="name" id="parseCsv"><span class="type-signature type-signature-async">(async) </span>parseCsv<span class="signature">(c)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
+    <h4 class="name" id="parseCsv"><span class="type-signature type-signature-async">(async) </span>parseCsv<span class="signature">(inp, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
@@ -222,7 +222,7 @@
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="WDataCsv.mjs.html">WDataCsv.mjs</a>, <a href="WDataCsv.mjs.html#line39">line 39</a>
+        <a href="WDataCsv.mjs.html">WDataCsv.mjs</a>, <a href="WDataCsv.mjs.html#line128">line 128</a>
     </li></ul></dd>
@@ -269,7 +269,7 @@
     <h5 class="h5-examples">Example</h5>
-    <pre class="prettyprint"><code>import wdc from './src/WDataCsv.mjs'
    .then((ltdt) => {
        console.log(ltdt)
        // => [ { NAME: 'Daffy Duck', AGE: '24' }, { NAME: 'Bugs 邦妮', AGE: '22' } ]
    })
    .catch((err) => {
        console.log(err)
    })</code></pre>
+    <pre class="prettyprint"><code>import wdc from './src/WDataCsv.mjs'
    .then((ltdt) => {
        console.log(ltdt)
        // => [ { NAME: 'Daffy Duck', AGE: '24' }, { NAME: 'Bugs 邦妮', AGE: '22' } ]
    })
    .catch((err) => {
        console.log(err)
    })
    .then((mat) => {
        console.log(mat)
        // => [ [ 'NAME', 'AGE' ], [ 'Daffy Duck', '24' ], [ 'Bugs 邦妮', '22' ] ]
    })
    .catch((err) => {
        console.log(err)
    })</code></pre>
@@ -287,8 +287,12 @@
         <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
         <th class="last">Description</th>
     </tr>
@@ -299,7 +303,7 @@
         <tr>
-                <td class="name"><code>c</code></td>
+                <td class="name"><code>inp</code></td>
             <td class="type">
@@ -313,156 +317,290 @@
             </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
             <td class="description last"><p>輸入CSV字串</p></td>
         </tr>
-    </tbody>
-</table>
+        <tr>
+                <td class="name"><code>opt</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                    <code>{}</code>
+                </td>
+            <td class="description last"><p>輸入設定物件，預設{}</p>
+                <h6>Properties</h6>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
-<h5 class="h5-returns">Returns:</h5>
+    <tbody>
-<div class="param-desc">
-    <p>回傳Promise，resolve回傳ltdt(各數據列為物件陣列)，reject回傳錯誤訊息</p>
-</div>
+        <tr>
+                <td class="name"><code>mode</code></td>
+            <td class="type">
+<span class="param-type">String</span>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
-    </dd>
-</dl>
+                </td>
+                <td class="default">
+                    <code>'ltdt'</code>
+                </td>
+            <td class="description last"><p>輸入回傳數據格式字串，可選ltdt(各數據列為物件)或mat(各數據列為陣列)，預設ltdt</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>headers</code></td>
+            <td class="type">
+<span class="param-type">Boolean</span>
+|
-    <h4 class="name" id="readCsv"><span class="type-signature type-signature-async">(async) </span>readCsv<span class="signature">(fp)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
+<span class="param-type">Array</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>讀取CSV檔，自動清除BOM</p></li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="WDataCsv.mjs.html">WDataCsv.mjs</a>, <a href="WDataCsv.mjs.html#line88">line 88</a>
-    </li></ul></dd>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入標頭設定，給false代表無標頭列，給陣列代表無標頭列且以此陣列為欄名，不給則取第1列為標頭。因csv-parser於給true時會使各列成為_0,_1等溢出鍵之壞數據，故給true時視為不給。另mode為mat時本設定固定為false</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>skipLines</code></td>
+            <td class="type">
+<span class="param-type">Number</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入解析前跳過列數整數。因csv-parser之註解列不計入行號，故與skipComments併用時計數基準會位移，兩者不建議同時使用</p></td>
+        </tr>
-</dl>
+        <tr>
+                <td class="name"><code>skipComments</code></td>
+            <td class="type">
+<span class="param-type">Boolean</span>
+|
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入忽略註解列設定，給true代表跳過#開頭之列，給字串代表以該字元為註解符</p></td>
+        </tr>
-    <h5 class="h5-examples">Example</h5>
-    <pre class="prettyprint"><code>import wdc from './src/WDataCsv.mjs'
    .then((ltdt) => {
        console.log(ltdt)
        // => [ { NAME: 'Daffy Duck', AGE: '24' }, { NAME: 'Bugs 邦妮', AGE: '22' } ]
    })
    .catch((err) => {
        console.log(err)
    })</code></pre>
+        <tr>
+                <td class="name"><code>separator</code></td>
+            <td class="type">
+<span class="param-type">String</span>
-    <h5 class="h5-parameters">Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
+            </td>
-        <th>Type</th>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入欄位分隔字元，因csv-parser僅取首個byte，故須為單字元</p></td>
+        </tr>
-    <tbody>
         <tr>
-                <td class="name"><code>fp</code></td>
+                <td class="name"><code>quote</code></td>
             <td class="type">
@@ -476,10 +614,972 @@
             </td>
+                <td class="attributes">
+                    &lt;optional><br>
-            <td class="description last"><p>輸入檔案位置字串</p></td>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入引號字元，因csv-parser僅取首個byte，故須為單字元</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>escape</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入逃逸字元，因csv-parser僅取首個byte，故須為單字元</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>newline</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入行尾字元，因csv-parser僅取首個byte，故須為單字元</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>strict</code></td>
+            <td class="type">
+<span class="param-type">Boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入各列欄數是否須與標頭數相符布林值。因csv-parser於headers為false時會強制關閉本設定，故mode為mat時本設定無效</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>mapHeaders</code></td>
+            <td class="type">
+<span class="param-type">function</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入標頭轉換函式。因csv-parser僅於解析標頭列時呼叫，故mode為mat時不會被呼叫。另回傳null時該欄將被整欄丟棄</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>mapValues</code></td>
+            <td class="type">
+<span class="param-type">function</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入欄值轉換函式。mode為mat時其header參數恆為undefined</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>maxRowBytes</code></td>
+            <td class="type">
+<span class="param-type">Number</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入單列位元組數上限整數</p></td>
+        </tr>
+    </tbody>
+</table>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    <p>回傳Promise，resolve回傳ltdt(各數據列為物件陣列)或mat(二維陣列)，reject回傳錯誤訊息</p>
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise</span>
+    </dd>
+</dl>
+    <h4 class="name" id="readCsv"><span class="type-signature type-signature-async">(async) </span>readCsv<span class="signature">(fp, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>讀取CSV檔，自動清除BOM</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="WDataCsv.mjs.html">WDataCsv.mjs</a>, <a href="WDataCsv.mjs.html#line186">line 186</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-examples">Example</h5>
+    <pre class="prettyprint"><code>import wdc from './src/WDataCsv.mjs'
    .then((ltdt) => {
        console.log(ltdt)
        // => [ { NAME: 'Daffy Duck', AGE: '24' }, { NAME: 'Bugs 邦妮', AGE: '22' } ]
    })
    .catch((err) => {
        console.log(err)
    })
    .then((mat) => {
        console.log(mat)
        // => [ [ 'NAME', 'AGE' ], [ 'Daffy Duck', '24' ], [ 'Bugs 邦妮', '22' ] ]
    })
    .catch((err) => {
        console.log(err)
    })</code></pre>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>fp</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入檔案位置字串</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>opt</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                    <code>{}</code>
+                </td>
+            <td class="description last"><p>輸入設定物件，預設{}</p>
+                <h6>Properties</h6>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>mode</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                    <code>'ltdt'</code>
+                </td>
+            <td class="description last"><p>輸入回傳數據格式字串，可選ltdt(各數據列為物件)或mat(各數據列為陣列)，預設ltdt</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>headers</code></td>
+            <td class="type">
+<span class="param-type">Boolean</span>
+|
+<span class="param-type">Array</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入標頭設定，給false代表無標頭列，給陣列代表無標頭列且以此陣列為欄名，不給則取第1列為標頭。因csv-parser於給true時會使各列成為_0,_1等溢出鍵之壞數據，故給true時視為不給。另mode為mat時本設定固定為false</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>skipLines</code></td>
+            <td class="type">
+<span class="param-type">Number</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入解析前跳過列數整數。因csv-parser之註解列不計入行號，故與skipComments併用時計數基準會位移，兩者不建議同時使用</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>skipComments</code></td>
+            <td class="type">
+<span class="param-type">Boolean</span>
+|
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入忽略註解列設定，給true代表跳過#開頭之列，給字串代表以該字元為註解符</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>separator</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入欄位分隔字元，因csv-parser僅取首個byte，故須為單字元</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>quote</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入引號字元，因csv-parser僅取首個byte，故須為單字元</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>escape</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入逃逸字元，因csv-parser僅取首個byte，故須為單字元</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>newline</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入行尾字元，因csv-parser僅取首個byte，故須為單字元</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>strict</code></td>
+            <td class="type">
+<span class="param-type">Boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入各列欄數是否須與標頭數相符布林值。因csv-parser於headers為false時會強制關閉本設定，故mode為mat時本設定無效</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>mapHeaders</code></td>
+            <td class="type">
+<span class="param-type">function</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入標頭轉換函式。因csv-parser僅於解析標頭列時呼叫，故mode為mat時不會被呼叫。另回傳null時該欄將被整欄丟棄</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>mapValues</code></td>
+            <td class="type">
+<span class="param-type">function</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入欄值轉換函式。mode為mat時其header參數恆為undefined</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>maxRowBytes</code></td>
+            <td class="type">
+<span class="param-type">Number</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>輸入單列位元組數上限整數</p></td>
+        </tr>
+    </tbody>
+</table>
+            </td>
         </tr>
@@ -505,7 +1605,7 @@
 <div class="param-desc">
-    <p>回傳Promise，resolve回傳ltdt(各數據列為物件陣列)，reject回傳錯誤訊息</p>
+    <p>回傳Promise，resolve回傳ltdt(各數據列為物件陣列)或mat(二維陣列)，reject回傳錯誤訊息</p>
 </div>
@@ -548,7 +1648,7 @@
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="WDataCsv.mjs.html">WDataCsv.mjs</a>, <a href="WDataCsv.mjs.html#line146">line 146</a>
+        <a href="WDataCsv.mjs.html">WDataCsv.mjs</a>, <a href="WDataCsv.mjs.html#line230">line 230</a>
     </li></ul></dd>
@@ -992,7 +2092,7 @@
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Fri Aug 07 2026 23:52:25 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Sat Aug 15 2026 17:02:41 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>