npm - convert-csv-to-json - Versions diffs - 4.13.0 → 4.14.0 - Mend

convert-csv-to-json 4.13.0 → 4.14.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 (65) hide show

package/.github/workflows/ci-cd.yml +1 -1
package/docs/api/BrowserApi.html +1255 -1028
package/docs/api/BrowserApiError.html +326 -179
package/docs/api/ConfigurationError.html +375 -224
package/docs/api/CsvFormatError.html +334 -187
package/docs/api/CsvParsingError.html +259 -132
package/docs/api/CsvToJson.html +1545 -1314
package/docs/api/CsvToJsonAsync.html +1356 -1148
package/docs/api/FileOperationError.html +213 -101
package/docs/api/FileUtils.html +568 -430
package/docs/api/InputValidationError.html +229 -115
package/docs/api/JsonUtil.html +222 -110
package/docs/api/JsonValidationError.html +197 -87
package/docs/api/StringUtils.html +833 -0
package/docs/api/global.html +1537 -1354
package/docs/api/index.html +114 -26
package/docs/api/index.js.html +137 -31
package/docs/api/scripts/app.min.js +1 -0
package/docs/api/scripts/linenumber.js +10 -9
package/docs/api/scripts/search.js +39 -0
package/docs/api/src_browserApi.js.html +120 -29
package/docs/api/src_csvToJson.js.html +119 -28
package/docs/api/src_csvToJsonAsync.js.html +118 -27
package/docs/api/src_util_errors.js.html +126 -28
package/docs/api/src_util_fileUtils.js.html +117 -26
package/docs/api/src_util_jsonUtils.js.html +117 -26
package/docs/api/src_util_stringUtils.js.html +121 -27
package/docs/api/styles/app.min.css +1 -0
package/docs/api/styles/iframe.css +13 -0
package/docs/api/styles/reset.css +44 -0
package/eslint.config.js +115 -0
package/index.js +21 -5
package/jsdoc.json +29 -4
package/package.json +5 -3
package/src/browserApi.js +4 -3
package/src/csvToJson.js +3 -2
package/src/csvToJsonAsync.js +2 -1
package/src/util/errors.js +10 -2
package/src/util/fileUtils.js +1 -0
package/src/util/jsonUtils.js +1 -0
package/src/util/stringUtils.js +5 -1
package/.eslintignore +0 -3
package/.eslintrc.json +0 -48
package/docs/api/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-Bold-webfont.svg +0 -1830
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 +0 -1830
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 +0 -1830
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 +0 -1831
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 +0 -1835
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 +0 -1831
package/docs/api/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/api/scripts/prettify/Apache-License-2.0.txt +0 -202
package/docs/api/scripts/prettify/lang-css.js +0 -2
package/docs/api/scripts/prettify/prettify.js +0 -28
package/docs/api/styles/jsdoc-default.css +0 -358

package/docs/api/CsvFormatError.html CHANGED Viewed

@@ -1,26 +1,107 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: CsvFormatError</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">
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> CsvFormatError</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="./node_modules/better-docs/css/better-docs.css">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
 </head>
-<body>
-<div id="main">
-    <h1 class="page-title">Class: CsvFormatError</h1>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+                <a class="image" href="index.html">
+                    <img src="https://raw.githubusercontent.com/iuccio/CSVtoJSON/master/CSVtoJSON.png" alt="logo">
+                </a>
+                <a href="index.html">
+                    <h1 class="navbar-item">Convert CSV to JSON</h1>
+                </a>
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    Documentation
+                </a>
+                        <a
+                            class="link user-link "
+                            href="https://github.com/iuccio/CSVtoJSON"
+                        >
+                            GitHub
+                        </a>
+                        <a
+                            class="link user-link "
+                            href="https://www.npmjs.com/package/convert-csv-to-json"
+                        >
+                            NPM
+                        </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar "
+            id="sidebarNav"
+        >
+            <nav>
+                    <h2><a href="index.html">Documentation</a></h2><div class="category"></div><div class="category"><h2>1-Core API</h2><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#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></div><div class="category"><h2>2-Sync</h2><h3>Classes</h3><ul><li><a href="CsvToJson.html">CsvToJson</a></li></ul></div><div class="category"><h2>3-Async</h2><h3>Classes</h3><ul><li><a href="CsvToJsonAsync.html">CsvToJsonAsync</a></li></ul></div><div class="category"><h2>4-Browser</h2><h3>Classes</h3><ul><li><a href="BrowserApi.html">BrowserApi</a></li></ul></div><div class="category"><h2>Error Classes</h2><h3>Classes</h3><ul><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="FileOperationError.html">FileOperationError</a></li><li><a href="InputValidationError.html">InputValidationError</a></li><li><a href="JsonValidationError.html">JsonValidationError</a></li></ul></div><div class="category"><h2>Utilities</h2><h3>Classes</h3><ul><li><a href="FileUtils.html">FileUtils</a></li><li><a href="JsonUtil.html">JsonUtil</a></li><li><a href="StringUtils.html">StringUtils</a></li></ul></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Class</p>
+                    <h1>CsvFormatError</h1>
+                </header>
@@ -40,25 +121,36 @@ Thrown when CSV format is invalid or malformed</p></div>
     <div class="container-overview">
+            <div class='vertical-section'>
+                <div class="members">
+                    <div class="member">
+                        <div class=name>
+                            <span class="tag">Constructor</span>
+                        </div>
-    <h2>Constructor</h2>
+    <h4 class="name" id="CsvFormatError">
+        <a class="href-link" href="#CsvFormatError">#</a>
+        <span class="code-name">
+                new CsvFormatError<span class="signature">(message, context)</span><span class="type-signature"></span>
+        </span>
+    </h4>
-    <h4 class="name" id="CsvFormatError"><span class="type-signature"></span>new CsvFormatError<span class="signature">(message, context)</span><span class="type-signature"></span></h4>
+    <div class="description">
+        <p>Create a CSV format error</p>
+    </div>
-<div class="description">
-    <p>Create a CSV format error</p>
-</div>
@@ -67,76 +159,80 @@ Thrown when CSV format is invalid or malformed</p></div>
     <h5>Parameters:</h5>
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            <th>Name</th>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
+            <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
+            <th class="last">Description</th>
+        </tr>
+        </thead>
-    <tbody>
+        <tbody>
-        <tr>
-                <td class="name"><code>message</code></td>
+<tr class="deep-level-0">
+      <td class="name"><code>message</code></td>
-            <td class="type">
-<span class="param-type">string</span>
+  <td class="type">
+<code class="param-type">string</code>
-            </td>
+  </td>
-            <td class="description last"><p>Error message</p></td>
-        </tr>
+  <td class="description last"><p>Error message</p></td>
+</tr>
-        <tr>
-                <td class="name"><code>context</code></td>
-            <td class="type">
-<span class="param-type">object</span>
+<tr class="deep-level-0">
+      <td class="name"><code>context</code></td>
+  <td class="type">
+<code class="param-type">object</code>
-            </td>
+  </td>
-            <td class="description last"><p>Additional context information (optional)</p></td>
-        </tr>
-    </tbody>
-</table>
+  <td class="description last"><p>Additional context information (optional)</p></td>
+</tr>
+        </tbody>
+    </table>
+</div>
@@ -166,18 +262,19 @@ Thrown when CSV format is invalid or malformed</p></div>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_util_errors.js.html">src/util/errors.js</a>, <a href="src_util_errors.js.html#line145">line 145</a>
-    </li></ul></dd>
+        <p class="tag-source">
+            <a href="src_util_errors.js.html" class="button">View Source</a>
+            <span>
+                <a href="src_util_errors.js.html">src/util/errors.js</a>, <a href="src_util_errors.js.html#line150">line 150</a>
+            </span>
+        </p>
 </dl>
@@ -200,11 +297,15 @@ Thrown when CSV format is invalid or malformed</p></div>
+                    </div>
+                </div>
+            </div>
     </div>
@@ -218,25 +319,38 @@ Thrown when CSV format is invalid or malformed</p></div>
-        <h3 class="subsection-title">Methods</h3>
+        <div class='vertical-section'>
+            <h1>Methods</h1>
+            <div class="members">
+                <div class="member">
-    <h4 class="name" id=".mismatchedQuotes"><span class="type-signature">(static) </span>mismatchedQuotes<span class="signature">(location)</span><span class="type-signature"> &rarr; {<a href="CsvFormatError.html">CsvFormatError</a>}</span></h4>
+    <h4 class="name" id=".mismatchedQuotes">
+        <a class="href-link" href="#.mismatchedQuotes">#</a>
+                <span class='tag'>static</span>
+        <span class="code-name">
+                mismatchedQuotes<span class="signature">(location)</span><span class="type-signature"> &rarr; {<a href="CsvFormatError.html">CsvFormatError</a>}</span>
+        </span>
+    </h4>
-<div class="description">
-    <p>Create error for mismatched quotes in CSV
+    <div class="description">
+        <p>Create error for mismatched quotes in CSV
 Occurs when quoted fields are not properly closed</p>
-</div>
+    </div>
@@ -248,60 +362,62 @@ Occurs when quoted fields are not properly closed</p>
     <h5>Parameters:</h5>
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            <th>Name</th>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
+            <th>Type</th>
-        <th>Default</th>
+            <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
+            <th class="last">Description</th>
+        </tr>
+        </thead>
-    <tbody>
+        <tbody>
-        <tr>
-                <td class="name"><code>location</code></td>
+<tr class="deep-level-0">
+      <td class="name"><code>location</code></td>
-            <td class="type">
-<span class="param-type">string</span>
+  <td class="type">
+<code class="param-type">string</code>
-            </td>
+  </td>
-                <td class="default">
-                    CSV
-                </td>
+      <td class="default">
+          CSV
+      </td>
-            <td class="description last"><p>Where the error occurred (default: 'CSV')</p></td>
-        </tr>
+  <td class="description last"><p>Where the error occurred (default: 'CSV')</p></td>
+</tr>
-    </tbody>
-</table>
+        </tbody>
+    </table>
+</div>
@@ -332,18 +448,19 @@ Occurs when quoted fields are not properly closed</p>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_util_errors.js.html">src/util/errors.js</a>, <a href="src_util_errors.js.html#line181">line 181</a>
-    </li></ul></dd>
+        <p class="tag-source">
+            <a href="src_util_errors.js.html" class="button">View Source</a>
+            <span>
+                <a href="src_util_errors.js.html">src/util/errors.js</a>, <a href="src_util_errors.js.html#line186">line 186</a>
+            </span>
+        </p>
 </dl>
@@ -361,50 +478,65 @@ Occurs when quoted fields are not properly closed</p>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>Configured error instance</p>
-</div>
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>Returns:</label></div>
+        <div class="column is-10">
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
+<div class="columns">
+    <div class='param-desc column is-7'><p>Configured error instance</p></div>
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
-<span class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></span>
+<code class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></code>
-    </dd>
-</dl>
+    </div>
+</div>
+        </div>
+    </div>
+</div>
+                <div class="member">
-    <h4 class="name" id=".missingHeader"><span class="type-signature">(static) </span>missingHeader<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="CsvFormatError.html">CsvFormatError</a>}</span></h4>
+    <h4 class="name" id=".missingHeader">
+        <a class="href-link" href="#.missingHeader">#</a>
+                <span class='tag'>static</span>
+        <span class="code-name">
+                missingHeader<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="CsvFormatError.html">CsvFormatError</a>}</span>
+        </span>
+    </h4>
-<div class="description">
-    <p>Create error for missing CSV header row
+    <div class="description">
+        <p>Create error for missing CSV header row
 Occurs when no valid header row is found in CSV</p>
-</div>
+    </div>
@@ -443,18 +575,19 @@ Occurs when no valid header row is found in CSV</p>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_util_errors.js.html">src/util/errors.js</a>, <a href="src_util_errors.js.html#line162">line 162</a>
-    </li></ul></dd>
+        <p class="tag-source">
+            <a href="src_util_errors.js.html" class="button">View Source</a>
+            <span>
+                <a href="src_util_errors.js.html">src/util/errors.js</a>, <a href="src_util_errors.js.html#line167">line 167</a>
+            </span>
+        </p>
 </dl>
@@ -472,34 +605,41 @@ Occurs when no valid header row is found in CSV</p>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>Configured error instance</p>
-</div>
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>Returns:</label></div>
+        <div class="column is-10">
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
+<div class="columns">
+    <div class='param-desc column is-7'><p>Configured error instance</p></div>
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
-<span class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></span>
+<code class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></code>
-    </dd>
-</dl>
+    </div>
+</div>
+        </div>
+    </div>
+</div>
+            </div>
+        </div>
@@ -512,19 +652,26 @@ Occurs when no valid header row is found in CSV</p>
-</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">
+            </div>
+            <footer class="footer">
+                <div class="content has-text-centered">
+                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a></p>
+                    <p class="sidebar-created-by">
+                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
+                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
+                    </p>
+                </div>
+            </footer>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.5</a> on Fri Mar 20 2026 16:08:52 GMT+0000 (Coordinated Universal Time)
-</footer>
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
 </body>
 </html>