npm - convert-csv-to-json - Versions diffs - 4.1.0 → 4.3.0 - Mend

convert-csv-to-json 4.1.0 → 4.3.0

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 (61) hide show

package/.eslintignore +3 -0
package/.eslintrc.json +48 -0
package/.github/workflows/ci-cd.yml +28 -2
package/SECURITY.md +2 -0
package/docs/api/BrowserApi.html +2435 -0
package/docs/api/BrowserApiError.html +522 -0
package/docs/api/ConfigurationError.html +594 -0
package/docs/api/CsvFormatError.html +530 -0
package/docs/api/CsvParsingError.html +384 -0
package/docs/api/CsvToJson.html +3136 -0
package/docs/api/CsvToJsonAsync.html +2672 -0
package/docs/api/FileOperationError.html +270 -0
package/docs/api/FileUtils.html +1012 -0
package/docs/api/InputValidationError.html +293 -0
package/docs/api/JsonUtil.html +340 -0
package/docs/api/JsonValidationError.html +247 -0
package/docs/api/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-Bold-webfont.svg +1830 -0
package/docs/api/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docs/api/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
package/docs/api/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docs/api/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-Italic-webfont.svg +1830 -0
package/docs/api/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docs/api/fonts/OpenSans-Light-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-Light-webfont.svg +1831 -0
package/docs/api/fonts/OpenSans-Light-webfont.woff +0 -0
package/docs/api/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
package/docs/api/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docs/api/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-Regular-webfont.svg +1831 -0
package/docs/api/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/api/global.html +3315 -0
package/docs/api/index.html +326 -0
package/docs/api/index.js.html +341 -0
package/docs/api/scripts/linenumber.js +25 -0
package/docs/api/scripts/prettify/Apache-License-2.0.txt +202 -0
package/docs/api/scripts/prettify/lang-css.js +2 -0
package/docs/api/scripts/prettify/prettify.js +28 -0
package/docs/api/src_browserApi.js.html +271 -0
package/docs/api/src_csvToJson.js.html +605 -0
package/docs/api/src_csvToJsonAsync.js.html +244 -0
package/docs/api/src_util_errors.js.html +374 -0
package/docs/api/src_util_fileUtils.js.html +147 -0
package/docs/api/src_util_jsonUtils.js.html +75 -0
package/docs/api/src_util_stringUtils.js.html +212 -0
package/docs/api/styles/jsdoc-default.css +358 -0
package/docs/api/styles/prettify-jsdoc.css +111 -0
package/docs/api/styles/prettify-tomorrow.css +132 -0
package/index.js +109 -32
package/jsdoc.json +17 -0
package/package.json +10 -3
package/src/browserApi.js +96 -4
package/src/csvToJson.js +163 -2
package/src/csvToJsonAsync.js +74 -14
package/src/util/errors.js +96 -0
package/src/util/fileUtils.js +34 -0
package/src/util/jsonUtils.js +8 -0
package/src/util/stringUtils.js +51 -0

package/docs/api/global.html ADDED Viewed

@@ -0,0 +1,3315 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Global</title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Global</h1>
+<section>
+<header>
+        <h2></h2>
+</header>
+<article>
+    <div class="container-overview">
+<dl class="details">
+</dl>
+    </div>
+        <h3 class="subsection-title">Members</h3>
+<h4 class="name" id="browser"><span class="type-signature"></span>browser<span class="type-signature"></span></h4>
+<div class="description">
+    <p>Browser API
+Provides parsing helpers suitable for browser environments (parsing strings and File/Blob objects)</p>
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line290">line 290</a>
+    </li></ul></dd>
+</dl>
+<h4 class="name" id="csvToJsonAsync"><span class="type-signature">(constant) </span>csvToJsonAsync<span class="type-signature"></span></h4>
+<div class="description">
+    <p>Parse CSV file asynchronously and return parsed data as JSON array</p>
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line236">line 236</a>
+    </li></ul></dd>
+</dl>
+    <h5>Example</h5>
+    <pre class="prettyprint"><code>const csvToJson = require('convert-csv-to-json');
+const data = await csvToJson.getJsonFromCsvAsync('resource/input.csv');
+console.log(data);</code></pre>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="asciiEncoding"><span class="type-signature"></span>asciiEncoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set ASCII encoding for reading files</p>
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line143">line 143</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="base64Encoding"><span class="type-signature"></span>base64Encoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set Base64 encoding for reading files</p>
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line152">line 152</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="csvStringToJson"><span class="type-signature"></span>csvStringToJson<span class="signature">(csvString)</span><span class="type-signature"> &rarr; {Array.&lt;object>}</span></h4>
+<div class="description">
+    <p>Parse a CSV string and return as JSON array of objects (synchronous)</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>csvString</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>CSV content as string</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line265">line 265</a>
+    </li></ul></dd>
+</dl>
+<h5>Throws:</h5>
+<ul>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If csvString is invalid</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type"><a href="InputValidationError.html">InputValidationError</a></span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If CSV is malformed</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+    </ul>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Array of objects representing CSV rows</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Array.&lt;object></span>
+    </dd>
+</dl>
+    <h5>Example</h5>
+    <pre class="prettyprint"><code>const csvToJson = require('convert-csv-to-json');
+const rows = csvToJson.csvStringToJson('name,age\nAlice,30');
+console.log(rows); // [{ name: 'Alice', age: '30' }]</code></pre>
+    <h4 class="name" id="csvStringToJsonStringified"><span class="type-signature"></span>csvStringToJsonStringified<span class="signature">(csvString)</span><span class="type-signature"> &rarr; {string}</span></h4>
+<div class="description">
+    <p>Parse CSV string and return as stringified JSON (synchronous)</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>csvString</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>CSV content as string</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line277">line 277</a>
+    </li></ul></dd>
+</dl>
+<h5>Throws:</h5>
+<ul>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If csvString is invalid</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type"><a href="InputValidationError.html">InputValidationError</a></span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If CSV is malformed</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If JSON generation fails</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type"><a href="JsonValidationError.html">JsonValidationError</a></span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+    </ul>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>JSON stringified array of objects</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">string</span>
+    </dd>
+</dl>
+    <h4 class="name" id="customEncoding"><span class="type-signature"></span>customEncoding<span class="signature">(encoding)</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set custom file encoding for reading CSV files
+Useful for non-UTF8 encoded files</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>encoding</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>Node.js supported encoding (e.g., 'utf8', 'latin1', 'ascii')</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line98">line 98</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="fieldDelimiter"><span class="type-signature"></span>fieldDelimiter<span class="signature">(delimiter)</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set the field delimiter character used to separate CSV fields</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>delimiter</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>Character(s) to use as field separator (default: ',')</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line48">line 48</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="formatValueByType"><span class="type-signature"></span>formatValueByType<span class="signature">(active)</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Enable or disable automatic type formatting for values
+Converts numeric strings to numbers, 'true'/'false' to booleans</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>active</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+            <td class="description last"><p>Whether to format values by type (default: true)</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line28">line 28</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="generateJsonFileFromCsv"><span class="type-signature"></span>generateJsonFileFromCsv<span class="signature">(inputFileName, outputFileName)</span><span class="type-signature"></span></h4>
+<div class="description">
+    <p>Parse CSV file and write the parsed JSON to an output file (synchronous)</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>inputFileName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>Path to input CSV file</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>outputFileName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>Path to output JSON file</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line193">line 193</a>
+    </li></ul></dd>
+</dl>
+<h5>Throws:</h5>
+<ul>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If inputFileName or outputFileName is not defined</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">Error</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If file operations fail</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type"><a href="FileOperationError.html">FileOperationError</a></span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If CSV is malformed</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+    </ul>
+    <h5>Example</h5>
+    <pre class="prettyprint"><code>const csvToJson = require('convert-csv-to-json');
+csvToJson.generateJsonFileFromCsv('input.csv', 'output.json');</code></pre>
+    <h4 class="name" id="getJsonFromCsv"><span class="type-signature"></span>getJsonFromCsv<span class="signature">(inputFileName)</span><span class="type-signature"> &rarr; {Array.&lt;object>}</span></h4>
+<div class="description">
+    <p>Parse CSV file and return parsed data as JSON array of objects (synchronous)</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>inputFileName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>Path to input CSV file</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line215">line 215</a>
+    </li></ul></dd>
+</dl>
+<h5>Throws:</h5>
+<ul>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If inputFileName is not defined</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">Error</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If file read fails</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type"><a href="FileOperationError.html">FileOperationError</a></span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc">
+        <p>If CSV is malformed</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl>
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+    </ul>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Array of objects representing CSV rows</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Array.&lt;object></span>
+    </dd>
+</dl>
+    <h5>Example</h5>
+    <pre class="prettyprint"><code>const csvToJson = require('convert-csv-to-json');
+const rows = csvToJson.getJsonFromCsv('resource/input.csv');
+console.log(rows);</code></pre>
+    <h4 class="name" id="hexEncoding"><span class="type-signature"></span>hexEncoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set Hex encoding for reading files</p>
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line161">line 161</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="indexHeader"><span class="type-signature"></span>indexHeader<span class="signature">(index)</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set the row index where CSV headers are located
+Use this if headers are not on the first line (row 0)</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>index</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+            <td class="description last"><p>Zero-based row index containing headers</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line71">line 71</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="latin1Encoding"><span class="type-signature"></span>latin1Encoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set Latin-1 (ISO-8859-1) encoding for reading files</p>
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line134">line 134</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="mapRows"><span class="type-signature"></span>mapRows<span class="signature">(mapperFn)</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set a mapper function to transform each row after conversion
+The mapper function receives (row, index) where row is the JSON object
+and index is the 0-based row number. Return null/undefined to filter out rows.</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>mapperFn</code></td>
+            <td class="type">
+<span class="param-type">function</span>
+            </td>
+            <td class="description last"><p>Function to transform each row: <code>(row, index) =&gt; transformedRow | null</code></p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line177">line 177</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h5>Example</h5>
+    <pre class="prettyprint"><code>csvToJson
+  .mapRows((row, idx) => idx % 2 === 0 ? row : null) // Keep every other row
+  .getJsonFromCsv('input.csv')</code></pre>
+    <h4 class="name" id="parseSubArray"><span class="type-signature"></span>parseSubArray<span class="signature">(delimiter, separator)</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Configure sub-array parsing for special field values
+Fields bracketed by delimiter and containing separator are parsed into arrays</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>delimiter</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>Bracket character (default: '*')</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>separator</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>Item separator within brackets (default: ',')</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line87">line 87</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h5>Example</h5>
+    <pre class="prettyprint"><code>// Input field: "*val1,val2,val3*"
+// Output array: ["val1", "val2", "val3"]
+csvToJson.parseSubArray('*', ',')</code></pre>
+    <h4 class="name" id="supportQuotedField"><span class="type-signature"></span>supportQuotedField<span class="signature">(active)</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Enable or disable support for RFC 4180 quoted fields
+When enabled, fields wrapped in double quotes can contain delimiters and newlines</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>active</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+            <td class="description last"><p>Whether to support quoted fields (default: false)</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line39">line 39</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="trimHeaderFieldWhiteSpace"><span class="type-signature"></span>trimHeaderFieldWhiteSpace<span class="signature">(active)</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Configure whitespace handling in CSV header field names
+When active, removes all whitespace from header names (e.g., &quot;My Name&quot; → &quot;MyName&quot;)
+When inactive, only trims leading and trailing whitespace</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>active</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+            <td class="description last"><p>Whether to remove all whitespace from headers (default: false)</p></td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line60">line 60</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="ucs2Encoding"><span class="type-signature"></span>ucs2Encoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set UCS-2 encoding for reading files</p>
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line116">line 116</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="utf16leEncoding"><span class="type-signature"></span>utf16leEncoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set UTF-16 LE encoding for reading files</p>
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line125">line 125</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="utf8Encoding"><span class="type-signature"></span>utf8Encoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Set UTF-8 encoding (default encoding)</p>
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line107">line 107</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>Module context for method chaining</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">object</span>
+    </dd>
+</dl>
+</article>
+</section>
+</div>
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BrowserApi.html">BrowserApi</a></li><li><a href="BrowserApiError.html">BrowserApiError</a></li><li><a href="ConfigurationError.html">ConfigurationError</a></li><li><a href="CsvFormatError.html">CsvFormatError</a></li><li><a href="CsvParsingError.html">CsvParsingError</a></li><li><a href="CsvToJson.html">CsvToJson</a></li><li><a href="CsvToJsonAsync.html">CsvToJsonAsync</a></li><li><a href="FileOperationError.html">FileOperationError</a></li><li><a href="FileUtils.html">FileUtils</a></li><li><a href="InputValidationError.html">InputValidationError</a></li><li><a href="JsonUtil.html">JsonUtil</a></li><li><a href="JsonValidationError.html">JsonValidationError</a></li></ul><h3>Global</h3><ul><li><a href="global.html#asciiEncoding">asciiEncoding</a></li><li><a href="global.html#base64Encoding">base64Encoding</a></li><li><a href="global.html#browser">browser</a></li><li><a href="global.html#csvStringToJson">csvStringToJson</a></li><li><a href="global.html#csvStringToJsonStringified">csvStringToJsonStringified</a></li><li><a href="global.html#csvToJsonAsync">csvToJsonAsync</a></li><li><a href="global.html#customEncoding">customEncoding</a></li><li><a href="global.html#fieldDelimiter">fieldDelimiter</a></li><li><a href="global.html#formatValueByType">formatValueByType</a></li><li><a href="global.html#generateJsonFileFromCsv">generateJsonFileFromCsv</a></li><li><a href="global.html#getJsonFromCsv">getJsonFromCsv</a></li><li><a href="global.html#hexEncoding">hexEncoding</a></li><li><a href="global.html#indexHeader">indexHeader</a></li><li><a href="global.html#latin1Encoding">latin1Encoding</a></li><li><a href="global.html#mapRows">mapRows</a></li><li><a href="global.html#parseSubArray">parseSubArray</a></li><li><a href="global.html#supportQuotedField">supportQuotedField</a></li><li><a href="global.html#trimHeaderFieldWhiteSpace">trimHeaderFieldWhiteSpace</a></li><li><a href="global.html#ucs2Encoding">ucs2Encoding</a></li><li><a href="global.html#utf16leEncoding">utf16leEncoding</a></li><li><a href="global.html#utf8Encoding">utf8Encoding</a></li></ul>
+</nav>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.5</a> on Fri Mar 20 2026 14:48:29 GMT+0000 (Coordinated Universal Time)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>