convert-csv-to-json 4.14.0 → 4.16.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 (38) hide show
  1. package/.github/workflows/ci-cd.yml +1 -1
  2. package/docs/.nojekyll +0 -0
  3. package/docs/README.md +44 -0
  4. package/docs/demo.bundle.js +1708 -0
  5. package/docs/index.html +536 -0
  6. package/eslint.config.js +1 -1
  7. package/package.json +5 -1
  8. package/docs/api/BrowserApi.html +0 -2662
  9. package/docs/api/BrowserApiError.html +0 -669
  10. package/docs/api/ConfigurationError.html +0 -745
  11. package/docs/api/CsvFormatError.html +0 -677
  12. package/docs/api/CsvParsingError.html +0 -511
  13. package/docs/api/CsvToJson.html +0 -3367
  14. package/docs/api/CsvToJsonAsync.html +0 -2880
  15. package/docs/api/FileOperationError.html +0 -382
  16. package/docs/api/FileUtils.html +0 -1150
  17. package/docs/api/InputValidationError.html +0 -407
  18. package/docs/api/JsonUtil.html +0 -452
  19. package/docs/api/JsonValidationError.html +0 -357
  20. package/docs/api/StringUtils.html +0 -833
  21. package/docs/api/global.html +0 -3498
  22. package/docs/api/index.html +0 -414
  23. package/docs/api/index.js.html +0 -447
  24. package/docs/api/scripts/app.min.js +0 -1
  25. package/docs/api/scripts/linenumber.js +0 -26
  26. package/docs/api/scripts/search.js +0 -39
  27. package/docs/api/src_browserApi.js.html +0 -362
  28. package/docs/api/src_csvToJson.js.html +0 -696
  29. package/docs/api/src_csvToJsonAsync.js.html +0 -335
  30. package/docs/api/src_util_errors.js.html +0 -472
  31. package/docs/api/src_util_fileUtils.js.html +0 -238
  32. package/docs/api/src_util_jsonUtils.js.html +0 -166
  33. package/docs/api/src_util_stringUtils.js.html +0 -306
  34. package/docs/api/styles/app.min.css +0 -1
  35. package/docs/api/styles/iframe.css +0 -13
  36. package/docs/api/styles/prettify-jsdoc.css +0 -111
  37. package/docs/api/styles/prettify-tomorrow.css +0 -132
  38. package/docs/api/styles/reset.css +0 -44
@@ -1,3498 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
-
4
- <head>
5
-
6
- <meta charset="utf-8">
7
- <meta name="viewport" content="width=device-width, initial-scale=1">
8
- <title> Global</title>
9
-
10
- <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
11
- <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
12
- <script src="./build/entry.js"></script>
13
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
14
- <!--[if lt IE 9]>
15
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
- <![endif]-->
17
- <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
18
- <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
19
- <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
20
- <link type="text/css" rel="stylesheet" href="styles/app.min.css">
21
- <link type="text/css" rel="stylesheet" href="styles/iframe.css">
22
- <link type="text/css" rel="stylesheet" href="./node_modules/better-docs/css/better-docs.css">
23
- <script async defer src="https://buttons.github.io/buttons.js"></script>
24
-
25
-
26
- </head>
27
-
28
-
29
-
30
- <body class="layout small-header">
31
- <div id="stickyNavbarOverlay"></div>
32
-
33
-
34
- <div class="top-nav">
35
- <div class="inner">
36
- <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
37
- <span aria-hidden="true"></span>
38
- <span aria-hidden="true"></span>
39
- <span aria-hidden="true"></span>
40
- </a>
41
- <div class="logo">
42
-
43
- <a class="image" href="index.html">
44
- <img src="https://raw.githubusercontent.com/iuccio/CSVtoJSON/master/CSVtoJSON.png" alt="logo">
45
- </a>
46
-
47
-
48
- <a href="index.html">
49
- <h1 class="navbar-item">Convert CSV to JSON</h1>
50
- </a>
51
-
52
- </div>
53
- <div class="menu">
54
-
55
- <div class="navigation">
56
- <a
57
- href="index.html"
58
- class="link"
59
- >
60
- Documentation
61
- </a>
62
-
63
-
64
-
65
- <a
66
- class="link user-link "
67
- href="https://github.com/iuccio/CSVtoJSON"
68
- >
69
- GitHub
70
- </a>
71
-
72
- <a
73
- class="link user-link "
74
- href="https://www.npmjs.com/package/convert-csv-to-json"
75
- >
76
- NPM
77
- </a>
78
-
79
-
80
-
81
- </div>
82
- </div>
83
- </div>
84
- </div>
85
- <div id="main">
86
- <div
87
- class="sidebar "
88
- id="sidebarNav"
89
- >
90
-
91
- <nav>
92
-
93
- <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>
94
-
95
- </nav>
96
- </div>
97
- <div class="core" id="main-content-wrapper">
98
- <div class="content">
99
- <header class="page-title">
100
- <p></p>
101
- <h1>Global</h1>
102
- </header>
103
-
104
-
105
-
106
-
107
-
108
- <section>
109
-
110
- <header>
111
-
112
- <h2></h2>
113
-
114
-
115
- </header>
116
-
117
- <article>
118
- <div class="container-overview">
119
-
120
-
121
-
122
-
123
-
124
-
125
- <dl class="details">
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
- </dl>
158
-
159
-
160
-
161
-
162
- </div>
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
- <div class='vertical-section'>
178
- <h1>Members</h1>
179
- <div class="members">
180
-
181
- <div class="member">
182
-
183
- <h4 class="name" id="csvToJsonAsync">
184
- <a class="href-link" href="#csvToJsonAsync">#</a>
185
-
186
-
187
- <span class='tag'>constant</span>
188
-
189
-
190
- <span class="code-name">
191
- csvToJsonAsync
192
- </span>
193
-
194
- </h4>
195
-
196
-
197
-
198
-
199
- <div class="description">
200
- <p>Parse CSV file asynchronously and return parsed data as JSON array</p>
201
- </div>
202
-
203
-
204
-
205
-
206
-
207
- <dl class="details">
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
- <p class="tag-source">
240
- <a href="index.js.html" class="button">View Source</a>
241
- <span>
242
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line254">line 254</a>
243
- </span>
244
- </p>
245
-
246
- </dl>
247
-
248
-
249
-
250
-
251
-
252
- <h5>Example</h5>
253
-
254
-
255
- <pre class="prettyprint"><code>const csvToJson = require('convert-csv-to-json');
256
- const data = await csvToJson.getJsonFromCsvAsync('resource/input.csv');
257
- console.log(data);</code></pre>
258
-
259
-
260
-
261
- </div>
262
-
263
- </div>
264
- </div>
265
-
266
-
267
-
268
- <div class='vertical-section'>
269
- <h1>Methods</h1>
270
- <div class="members">
271
-
272
- <div class="member">
273
-
274
-
275
-
276
- <h4 class="name" id="asciiEncoding">
277
- <a class="href-link" href="#asciiEncoding">#</a>
278
-
279
- <span class="code-name">
280
-
281
- asciiEncoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span>
282
-
283
- </span>
284
- </h4>
285
-
286
-
287
-
288
-
289
- <div class="description">
290
- <p>Set ASCII encoding for reading files</p>
291
- </div>
292
-
293
-
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
- <dl class="details">
307
-
308
-
309
-
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
-
338
- <p class="tag-source">
339
- <a href="index.js.html" class="button">View Source</a>
340
- <span>
341
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line155">line 155</a>
342
- </span>
343
- </p>
344
-
345
- </dl>
346
-
347
-
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
- <div class='columns method-parameter'>
365
- <div class="column is-2"><label>Returns:</label></div>
366
- <div class="column is-10">
367
-
368
-
369
-
370
- <div class="columns">
371
-
372
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
373
-
374
-
375
- <div class='column is-5 has-text-left'>
376
- <label>Type: </label>
377
-
378
- <code class="param-type">object</code>
379
-
380
-
381
- </div>
382
-
383
- </div>
384
-
385
-
386
- </div>
387
- </div>
388
-
389
-
390
-
391
-
392
- </div>
393
-
394
- <div class="member">
395
-
396
-
397
-
398
- <h4 class="name" id="base64Encoding">
399
- <a class="href-link" href="#base64Encoding">#</a>
400
-
401
- <span class="code-name">
402
-
403
- base64Encoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span>
404
-
405
- </span>
406
- </h4>
407
-
408
-
409
-
410
-
411
- <div class="description">
412
- <p>Set Base64 encoding for reading files</p>
413
- </div>
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
- <dl class="details">
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
- <p class="tag-source">
461
- <a href="index.js.html" class="button">View Source</a>
462
- <span>
463
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line165">line 165</a>
464
- </span>
465
- </p>
466
-
467
- </dl>
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
- <div class='columns method-parameter'>
487
- <div class="column is-2"><label>Returns:</label></div>
488
- <div class="column is-10">
489
-
490
-
491
-
492
- <div class="columns">
493
-
494
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
495
-
496
-
497
- <div class='column is-5 has-text-left'>
498
- <label>Type: </label>
499
-
500
- <code class="param-type">object</code>
501
-
502
-
503
- </div>
504
-
505
- </div>
506
-
507
-
508
- </div>
509
- </div>
510
-
511
-
512
-
513
-
514
- </div>
515
-
516
- <div class="member">
517
-
518
-
519
-
520
- <h4 class="name" id="csvStringToJson">
521
- <a class="href-link" href="#csvStringToJson">#</a>
522
-
523
- <span class="code-name">
524
-
525
- csvStringToJson<span class="signature">(csvString)</span><span class="type-signature"> &rarr; {Array.&lt;object>}</span>
526
-
527
- </span>
528
- </h4>
529
-
530
-
531
-
532
-
533
- <div class="description">
534
- <p>Parse a CSV string and return as JSON array of objects (synchronous)</p>
535
- </div>
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
- <h5>Parameters:</h5>
547
-
548
- <div class="table-container">
549
- <table class="params table">
550
- <thead>
551
- <tr>
552
-
553
- <th>Name</th>
554
-
555
-
556
- <th>Type</th>
557
-
558
-
559
-
560
-
561
-
562
- <th class="last">Description</th>
563
- </tr>
564
- </thead>
565
-
566
- <tbody>
567
-
568
-
569
-
570
- <tr class="deep-level-0">
571
-
572
- <td class="name"><code>csvString</code></td>
573
-
574
-
575
- <td class="type">
576
-
577
-
578
- <code class="param-type">string</code>
579
-
580
-
581
-
582
- </td>
583
-
584
-
585
-
586
-
587
-
588
- <td class="description last"><p>CSV content as string</p></td>
589
- </tr>
590
-
591
-
592
-
593
- </tbody>
594
- </table>
595
- </div>
596
-
597
-
598
-
599
-
600
-
601
- <dl class="details">
602
-
603
-
604
-
605
-
606
-
607
-
608
-
609
-
610
-
611
-
612
-
613
-
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
-
622
-
623
-
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
- <p class="tag-source">
634
- <a href="index.js.html" class="button">View Source</a>
635
- <span>
636
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line284">line 284</a>
637
- </span>
638
- </p>
639
-
640
- </dl>
641
-
642
-
643
-
644
-
645
-
646
-
647
-
648
-
649
-
650
-
651
-
652
-
653
-
654
-
655
-
656
-
657
- <div class='columns method-parameter'>
658
- <div class="column is-2"><label>Throws:</label></div>
659
- <div class="column is-10">
660
-
661
-
662
- <div class="columns">
663
-
664
- <div class='param-desc column is-7'><p>If csvString is invalid</p></div>
665
- <div class='column is-5 has-text-left'>
666
- <label>Type: </label>
667
- <code class="param-type"><a href="InputValidationError.html">InputValidationError</a></code>
668
-
669
-
670
- </div>
671
-
672
- </div>
673
-
674
-
675
-
676
- <div class="columns">
677
-
678
- <div class='param-desc column is-7'><p>If CSV is malformed</p></div>
679
- <div class='column is-5 has-text-left'>
680
- <label>Type: </label>
681
- <code class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></code>
682
-
683
-
684
- </div>
685
-
686
- </div>
687
-
688
-
689
- </div>
690
- </div>
691
-
692
-
693
-
694
- <div class='columns method-parameter'>
695
- <div class="column is-2"><label>Returns:</label></div>
696
- <div class="column is-10">
697
-
698
-
699
-
700
- <div class="columns">
701
-
702
- <div class='param-desc column is-7'><p>Array of objects representing CSV rows</p></div>
703
-
704
-
705
- <div class='column is-5 has-text-left'>
706
- <label>Type: </label>
707
-
708
- <code class="param-type">Array.&lt;object></code>
709
-
710
-
711
- </div>
712
-
713
- </div>
714
-
715
-
716
- </div>
717
- </div>
718
-
719
-
720
-
721
-
722
- <h5>Example</h5>
723
-
724
-
725
- <pre class="prettyprint"><code>const csvToJson = require('convert-csv-to-json');
726
- const rows = csvToJson.csvStringToJson('name,age\nAlice,30');
727
- console.log(rows); // [{ name: 'Alice', age: '30' }]</code></pre>
728
-
729
-
730
-
731
- </div>
732
-
733
- <div class="member">
734
-
735
-
736
-
737
- <h4 class="name" id="csvStringToJsonStringified">
738
- <a class="href-link" href="#csvStringToJsonStringified">#</a>
739
-
740
- <span class="code-name">
741
-
742
- csvStringToJsonStringified<span class="signature">(csvString)</span><span class="type-signature"> &rarr; {string}</span>
743
-
744
- </span>
745
- </h4>
746
-
747
-
748
-
749
-
750
- <div class="description">
751
- <p>Parse CSV string and return as stringified JSON (synchronous)</p>
752
- </div>
753
-
754
-
755
-
756
-
757
-
758
-
759
-
760
-
761
-
762
-
763
- <h5>Parameters:</h5>
764
-
765
- <div class="table-container">
766
- <table class="params table">
767
- <thead>
768
- <tr>
769
-
770
- <th>Name</th>
771
-
772
-
773
- <th>Type</th>
774
-
775
-
776
-
777
-
778
-
779
- <th class="last">Description</th>
780
- </tr>
781
- </thead>
782
-
783
- <tbody>
784
-
785
-
786
-
787
- <tr class="deep-level-0">
788
-
789
- <td class="name"><code>csvString</code></td>
790
-
791
-
792
- <td class="type">
793
-
794
-
795
- <code class="param-type">string</code>
796
-
797
-
798
-
799
- </td>
800
-
801
-
802
-
803
-
804
-
805
- <td class="description last"><p>CSV content as string</p></td>
806
- </tr>
807
-
808
-
809
-
810
- </tbody>
811
- </table>
812
- </div>
813
-
814
-
815
-
816
-
817
-
818
- <dl class="details">
819
-
820
-
821
-
822
-
823
-
824
-
825
-
826
-
827
-
828
-
829
-
830
-
831
-
832
-
833
-
834
-
835
-
836
-
837
-
838
-
839
-
840
-
841
-
842
-
843
-
844
-
845
-
846
-
847
-
848
-
849
-
850
- <p class="tag-source">
851
- <a href="index.js.html" class="button">View Source</a>
852
- <span>
853
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line297">line 297</a>
854
- </span>
855
- </p>
856
-
857
- </dl>
858
-
859
-
860
-
861
-
862
-
863
-
864
-
865
-
866
-
867
-
868
-
869
-
870
-
871
-
872
-
873
-
874
- <div class='columns method-parameter'>
875
- <div class="column is-2"><label>Throws:</label></div>
876
- <div class="column is-10">
877
-
878
-
879
- <div class="columns">
880
-
881
- <div class='param-desc column is-7'><p>If csvString is invalid</p></div>
882
- <div class='column is-5 has-text-left'>
883
- <label>Type: </label>
884
- <code class="param-type"><a href="InputValidationError.html">InputValidationError</a></code>
885
-
886
-
887
- </div>
888
-
889
- </div>
890
-
891
-
892
-
893
- <div class="columns">
894
-
895
- <div class='param-desc column is-7'><p>If CSV is malformed</p></div>
896
- <div class='column is-5 has-text-left'>
897
- <label>Type: </label>
898
- <code class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></code>
899
-
900
-
901
- </div>
902
-
903
- </div>
904
-
905
-
906
-
907
- <div class="columns">
908
-
909
- <div class='param-desc column is-7'><p>If JSON generation fails</p></div>
910
- <div class='column is-5 has-text-left'>
911
- <label>Type: </label>
912
- <code class="param-type"><a href="JsonValidationError.html">JsonValidationError</a></code>
913
-
914
-
915
- </div>
916
-
917
- </div>
918
-
919
-
920
- </div>
921
- </div>
922
-
923
-
924
-
925
- <div class='columns method-parameter'>
926
- <div class="column is-2"><label>Returns:</label></div>
927
- <div class="column is-10">
928
-
929
-
930
-
931
- <div class="columns">
932
-
933
- <div class='param-desc column is-7'><p>JSON stringified array of objects</p></div>
934
-
935
-
936
- <div class='column is-5 has-text-left'>
937
- <label>Type: </label>
938
-
939
- <code class="param-type">string</code>
940
-
941
-
942
- </div>
943
-
944
- </div>
945
-
946
-
947
- </div>
948
- </div>
949
-
950
-
951
-
952
-
953
- </div>
954
-
955
- <div class="member">
956
-
957
-
958
-
959
- <h4 class="name" id="customEncoding">
960
- <a class="href-link" href="#customEncoding">#</a>
961
-
962
- <span class="code-name">
963
-
964
- customEncoding<span class="signature">(encoding)</span><span class="type-signature"> &rarr; {object}</span>
965
-
966
- </span>
967
- </h4>
968
-
969
-
970
-
971
-
972
- <div class="description">
973
- <p>Set custom file encoding for reading CSV files
974
- Useful for non-UTF8 encoded files</p>
975
- </div>
976
-
977
-
978
-
979
-
980
-
981
-
982
-
983
-
984
-
985
-
986
- <h5>Parameters:</h5>
987
-
988
- <div class="table-container">
989
- <table class="params table">
990
- <thead>
991
- <tr>
992
-
993
- <th>Name</th>
994
-
995
-
996
- <th>Type</th>
997
-
998
-
999
-
1000
-
1001
-
1002
- <th class="last">Description</th>
1003
- </tr>
1004
- </thead>
1005
-
1006
- <tbody>
1007
-
1008
-
1009
-
1010
- <tr class="deep-level-0">
1011
-
1012
- <td class="name"><code>encoding</code></td>
1013
-
1014
-
1015
- <td class="type">
1016
-
1017
-
1018
- <code class="param-type">string</code>
1019
-
1020
-
1021
-
1022
- </td>
1023
-
1024
-
1025
-
1026
-
1027
-
1028
- <td class="description last"><p>Node.js supported encoding (e.g., 'utf8', 'latin1', 'ascii')</p></td>
1029
- </tr>
1030
-
1031
-
1032
-
1033
- </tbody>
1034
- </table>
1035
- </div>
1036
-
1037
-
1038
-
1039
-
1040
-
1041
- <dl class="details">
1042
-
1043
-
1044
-
1045
-
1046
-
1047
-
1048
-
1049
-
1050
-
1051
-
1052
-
1053
-
1054
-
1055
-
1056
-
1057
-
1058
-
1059
-
1060
-
1061
-
1062
-
1063
-
1064
-
1065
-
1066
-
1067
-
1068
-
1069
-
1070
-
1071
-
1072
-
1073
- <p class="tag-source">
1074
- <a href="index.js.html" class="button">View Source</a>
1075
- <span>
1076
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line105">line 105</a>
1077
- </span>
1078
- </p>
1079
-
1080
- </dl>
1081
-
1082
-
1083
-
1084
-
1085
-
1086
-
1087
-
1088
-
1089
-
1090
-
1091
-
1092
-
1093
-
1094
-
1095
-
1096
-
1097
-
1098
-
1099
- <div class='columns method-parameter'>
1100
- <div class="column is-2"><label>Returns:</label></div>
1101
- <div class="column is-10">
1102
-
1103
-
1104
-
1105
- <div class="columns">
1106
-
1107
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
1108
-
1109
-
1110
- <div class='column is-5 has-text-left'>
1111
- <label>Type: </label>
1112
-
1113
- <code class="param-type">object</code>
1114
-
1115
-
1116
- </div>
1117
-
1118
- </div>
1119
-
1120
-
1121
- </div>
1122
- </div>
1123
-
1124
-
1125
-
1126
-
1127
- </div>
1128
-
1129
- <div class="member">
1130
-
1131
-
1132
-
1133
- <h4 class="name" id="fieldDelimiter">
1134
- <a class="href-link" href="#fieldDelimiter">#</a>
1135
-
1136
- <span class="code-name">
1137
-
1138
- fieldDelimiter<span class="signature">(delimiter)</span><span class="type-signature"> &rarr; {object}</span>
1139
-
1140
- </span>
1141
- </h4>
1142
-
1143
-
1144
-
1145
-
1146
- <div class="description">
1147
- <p>Set the field delimiter character used to separate CSV fields</p>
1148
- </div>
1149
-
1150
-
1151
-
1152
-
1153
-
1154
-
1155
-
1156
-
1157
-
1158
-
1159
- <h5>Parameters:</h5>
1160
-
1161
- <div class="table-container">
1162
- <table class="params table">
1163
- <thead>
1164
- <tr>
1165
-
1166
- <th>Name</th>
1167
-
1168
-
1169
- <th>Type</th>
1170
-
1171
-
1172
-
1173
-
1174
-
1175
- <th class="last">Description</th>
1176
- </tr>
1177
- </thead>
1178
-
1179
- <tbody>
1180
-
1181
-
1182
-
1183
- <tr class="deep-level-0">
1184
-
1185
- <td class="name"><code>delimiter</code></td>
1186
-
1187
-
1188
- <td class="type">
1189
-
1190
-
1191
- <code class="param-type">string</code>
1192
-
1193
-
1194
-
1195
- </td>
1196
-
1197
-
1198
-
1199
-
1200
-
1201
- <td class="description last"><p>Character(s) to use as field separator (default: ',')</p></td>
1202
- </tr>
1203
-
1204
-
1205
-
1206
- </tbody>
1207
- </table>
1208
- </div>
1209
-
1210
-
1211
-
1212
-
1213
-
1214
- <dl class="details">
1215
-
1216
-
1217
-
1218
-
1219
-
1220
-
1221
-
1222
-
1223
-
1224
-
1225
-
1226
-
1227
-
1228
-
1229
-
1230
-
1231
-
1232
-
1233
-
1234
-
1235
-
1236
-
1237
-
1238
-
1239
-
1240
-
1241
-
1242
-
1243
-
1244
-
1245
-
1246
- <p class="tag-source">
1247
- <a href="index.js.html" class="button">View Source</a>
1248
- <span>
1249
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line51">line 51</a>
1250
- </span>
1251
- </p>
1252
-
1253
- </dl>
1254
-
1255
-
1256
-
1257
-
1258
-
1259
-
1260
-
1261
-
1262
-
1263
-
1264
-
1265
-
1266
-
1267
-
1268
-
1269
-
1270
-
1271
-
1272
- <div class='columns method-parameter'>
1273
- <div class="column is-2"><label>Returns:</label></div>
1274
- <div class="column is-10">
1275
-
1276
-
1277
-
1278
- <div class="columns">
1279
-
1280
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
1281
-
1282
-
1283
- <div class='column is-5 has-text-left'>
1284
- <label>Type: </label>
1285
-
1286
- <code class="param-type">object</code>
1287
-
1288
-
1289
- </div>
1290
-
1291
- </div>
1292
-
1293
-
1294
- </div>
1295
- </div>
1296
-
1297
-
1298
-
1299
-
1300
- </div>
1301
-
1302
- <div class="member">
1303
-
1304
-
1305
-
1306
- <h4 class="name" id="formatValueByType">
1307
- <a class="href-link" href="#formatValueByType">#</a>
1308
-
1309
- <span class="code-name">
1310
-
1311
- formatValueByType<span class="signature">(active)</span><span class="type-signature"> &rarr; {object}</span>
1312
-
1313
- </span>
1314
- </h4>
1315
-
1316
-
1317
-
1318
-
1319
- <div class="description">
1320
- <p>Enable or disable automatic type formatting for values
1321
- Converts numeric strings to numbers, 'true'/'false' to booleans</p>
1322
- </div>
1323
-
1324
-
1325
-
1326
-
1327
-
1328
-
1329
-
1330
-
1331
-
1332
-
1333
- <h5>Parameters:</h5>
1334
-
1335
- <div class="table-container">
1336
- <table class="params table">
1337
- <thead>
1338
- <tr>
1339
-
1340
- <th>Name</th>
1341
-
1342
-
1343
- <th>Type</th>
1344
-
1345
-
1346
-
1347
-
1348
-
1349
- <th class="last">Description</th>
1350
- </tr>
1351
- </thead>
1352
-
1353
- <tbody>
1354
-
1355
-
1356
-
1357
- <tr class="deep-level-0">
1358
-
1359
- <td class="name"><code>active</code></td>
1360
-
1361
-
1362
- <td class="type">
1363
-
1364
-
1365
- <code class="param-type">boolean</code>
1366
-
1367
-
1368
-
1369
- </td>
1370
-
1371
-
1372
-
1373
-
1374
-
1375
- <td class="description last"><p>Whether to format values by type (default: true)</p></td>
1376
- </tr>
1377
-
1378
-
1379
-
1380
- </tbody>
1381
- </table>
1382
- </div>
1383
-
1384
-
1385
-
1386
-
1387
-
1388
- <dl class="details">
1389
-
1390
-
1391
-
1392
-
1393
-
1394
-
1395
-
1396
-
1397
-
1398
-
1399
-
1400
-
1401
-
1402
-
1403
-
1404
-
1405
-
1406
-
1407
-
1408
-
1409
-
1410
-
1411
-
1412
-
1413
-
1414
-
1415
-
1416
-
1417
-
1418
-
1419
-
1420
- <p class="tag-source">
1421
- <a href="index.js.html" class="button">View Source</a>
1422
- <span>
1423
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line29">line 29</a>
1424
- </span>
1425
- </p>
1426
-
1427
- </dl>
1428
-
1429
-
1430
-
1431
-
1432
-
1433
-
1434
-
1435
-
1436
-
1437
-
1438
-
1439
-
1440
-
1441
-
1442
-
1443
-
1444
-
1445
-
1446
- <div class='columns method-parameter'>
1447
- <div class="column is-2"><label>Returns:</label></div>
1448
- <div class="column is-10">
1449
-
1450
-
1451
-
1452
- <div class="columns">
1453
-
1454
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
1455
-
1456
-
1457
- <div class='column is-5 has-text-left'>
1458
- <label>Type: </label>
1459
-
1460
- <code class="param-type">object</code>
1461
-
1462
-
1463
- </div>
1464
-
1465
- </div>
1466
-
1467
-
1468
- </div>
1469
- </div>
1470
-
1471
-
1472
-
1473
-
1474
- </div>
1475
-
1476
- <div class="member">
1477
-
1478
-
1479
-
1480
- <h4 class="name" id="generateJsonFileFromCsv">
1481
- <a class="href-link" href="#generateJsonFileFromCsv">#</a>
1482
-
1483
- <span class="code-name">
1484
-
1485
- generateJsonFileFromCsv<span class="signature">(inputFileName, outputFileName)</span><span class="type-signature"></span>
1486
-
1487
- </span>
1488
- </h4>
1489
-
1490
-
1491
-
1492
-
1493
- <div class="description">
1494
- <p>Parse CSV file and write the parsed JSON to an output file (synchronous)</p>
1495
- </div>
1496
-
1497
-
1498
-
1499
-
1500
-
1501
-
1502
-
1503
-
1504
-
1505
-
1506
- <h5>Parameters:</h5>
1507
-
1508
- <div class="table-container">
1509
- <table class="params table">
1510
- <thead>
1511
- <tr>
1512
-
1513
- <th>Name</th>
1514
-
1515
-
1516
- <th>Type</th>
1517
-
1518
-
1519
-
1520
-
1521
-
1522
- <th class="last">Description</th>
1523
- </tr>
1524
- </thead>
1525
-
1526
- <tbody>
1527
-
1528
-
1529
-
1530
- <tr class="deep-level-0">
1531
-
1532
- <td class="name"><code>inputFileName</code></td>
1533
-
1534
-
1535
- <td class="type">
1536
-
1537
-
1538
- <code class="param-type">string</code>
1539
-
1540
-
1541
-
1542
- </td>
1543
-
1544
-
1545
-
1546
-
1547
-
1548
- <td class="description last"><p>Path to input CSV file</p></td>
1549
- </tr>
1550
-
1551
-
1552
-
1553
-
1554
-
1555
- <tr class="deep-level-0">
1556
-
1557
- <td class="name"><code>outputFileName</code></td>
1558
-
1559
-
1560
- <td class="type">
1561
-
1562
-
1563
- <code class="param-type">string</code>
1564
-
1565
-
1566
-
1567
- </td>
1568
-
1569
-
1570
-
1571
-
1572
-
1573
- <td class="description last"><p>Path to output JSON file</p></td>
1574
- </tr>
1575
-
1576
-
1577
-
1578
- </tbody>
1579
- </table>
1580
- </div>
1581
-
1582
-
1583
-
1584
-
1585
-
1586
- <dl class="details">
1587
-
1588
-
1589
-
1590
-
1591
-
1592
-
1593
-
1594
-
1595
-
1596
-
1597
-
1598
-
1599
-
1600
-
1601
-
1602
-
1603
-
1604
-
1605
-
1606
-
1607
-
1608
-
1609
-
1610
-
1611
-
1612
-
1613
-
1614
-
1615
-
1616
-
1617
-
1618
- <p class="tag-source">
1619
- <a href="index.js.html" class="button">View Source</a>
1620
- <span>
1621
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line209">line 209</a>
1622
- </span>
1623
- </p>
1624
-
1625
- </dl>
1626
-
1627
-
1628
-
1629
-
1630
-
1631
-
1632
-
1633
-
1634
-
1635
-
1636
-
1637
-
1638
-
1639
-
1640
-
1641
-
1642
- <div class='columns method-parameter'>
1643
- <div class="column is-2"><label>Throws:</label></div>
1644
- <div class="column is-10">
1645
-
1646
-
1647
- <div class="columns">
1648
-
1649
- <div class='param-desc column is-7'><p>If inputFileName or outputFileName is not defined</p></div>
1650
- <div class='column is-5 has-text-left'>
1651
- <label>Type: </label>
1652
- <code class="param-type">Error</code>
1653
-
1654
-
1655
- </div>
1656
-
1657
- </div>
1658
-
1659
-
1660
-
1661
- <div class="columns">
1662
-
1663
- <div class='param-desc column is-7'><p>If file operations fail</p></div>
1664
- <div class='column is-5 has-text-left'>
1665
- <label>Type: </label>
1666
- <code class="param-type"><a href="FileOperationError.html">FileOperationError</a></code>
1667
-
1668
-
1669
- </div>
1670
-
1671
- </div>
1672
-
1673
-
1674
-
1675
- <div class="columns">
1676
-
1677
- <div class='param-desc column is-7'><p>If CSV is malformed</p></div>
1678
- <div class='column is-5 has-text-left'>
1679
- <label>Type: </label>
1680
- <code class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></code>
1681
-
1682
-
1683
- </div>
1684
-
1685
- </div>
1686
-
1687
-
1688
- </div>
1689
- </div>
1690
-
1691
-
1692
-
1693
-
1694
-
1695
-
1696
- <h5>Example</h5>
1697
-
1698
-
1699
- <pre class="prettyprint"><code>const csvToJson = require('convert-csv-to-json');
1700
- csvToJson.generateJsonFileFromCsv('input.csv', 'output.json');</code></pre>
1701
-
1702
-
1703
-
1704
- </div>
1705
-
1706
- <div class="member">
1707
-
1708
-
1709
-
1710
- <h4 class="name" id="getJsonFromCsv">
1711
- <a class="href-link" href="#getJsonFromCsv">#</a>
1712
-
1713
- <span class="code-name">
1714
-
1715
- getJsonFromCsv<span class="signature">(inputFileName)</span><span class="type-signature"> &rarr; {Array.&lt;object>}</span>
1716
-
1717
- </span>
1718
- </h4>
1719
-
1720
-
1721
-
1722
-
1723
- <div class="description">
1724
- <p>Parse CSV file and return parsed data as JSON array of objects (synchronous)</p>
1725
- </div>
1726
-
1727
-
1728
-
1729
-
1730
-
1731
-
1732
-
1733
-
1734
-
1735
-
1736
- <h5>Parameters:</h5>
1737
-
1738
- <div class="table-container">
1739
- <table class="params table">
1740
- <thead>
1741
- <tr>
1742
-
1743
- <th>Name</th>
1744
-
1745
-
1746
- <th>Type</th>
1747
-
1748
-
1749
-
1750
-
1751
-
1752
- <th class="last">Description</th>
1753
- </tr>
1754
- </thead>
1755
-
1756
- <tbody>
1757
-
1758
-
1759
-
1760
- <tr class="deep-level-0">
1761
-
1762
- <td class="name"><code>inputFileName</code></td>
1763
-
1764
-
1765
- <td class="type">
1766
-
1767
-
1768
- <code class="param-type">string</code>
1769
-
1770
-
1771
-
1772
- </td>
1773
-
1774
-
1775
-
1776
-
1777
-
1778
- <td class="description last"><p>Path to input CSV file</p></td>
1779
- </tr>
1780
-
1781
-
1782
-
1783
- </tbody>
1784
- </table>
1785
- </div>
1786
-
1787
-
1788
-
1789
-
1790
-
1791
- <dl class="details">
1792
-
1793
-
1794
-
1795
-
1796
-
1797
-
1798
-
1799
-
1800
-
1801
-
1802
-
1803
-
1804
-
1805
-
1806
-
1807
-
1808
-
1809
-
1810
-
1811
-
1812
-
1813
-
1814
-
1815
-
1816
-
1817
-
1818
-
1819
-
1820
-
1821
-
1822
-
1823
- <p class="tag-source">
1824
- <a href="index.js.html" class="button">View Source</a>
1825
- <span>
1826
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line232">line 232</a>
1827
- </span>
1828
- </p>
1829
-
1830
- </dl>
1831
-
1832
-
1833
-
1834
-
1835
-
1836
-
1837
-
1838
-
1839
-
1840
-
1841
-
1842
-
1843
-
1844
-
1845
-
1846
-
1847
- <div class='columns method-parameter'>
1848
- <div class="column is-2"><label>Throws:</label></div>
1849
- <div class="column is-10">
1850
-
1851
-
1852
- <div class="columns">
1853
-
1854
- <div class='param-desc column is-7'><p>If inputFileName is not defined</p></div>
1855
- <div class='column is-5 has-text-left'>
1856
- <label>Type: </label>
1857
- <code class="param-type">Error</code>
1858
-
1859
-
1860
- </div>
1861
-
1862
- </div>
1863
-
1864
-
1865
-
1866
- <div class="columns">
1867
-
1868
- <div class='param-desc column is-7'><p>If file read fails</p></div>
1869
- <div class='column is-5 has-text-left'>
1870
- <label>Type: </label>
1871
- <code class="param-type"><a href="FileOperationError.html">FileOperationError</a></code>
1872
-
1873
-
1874
- </div>
1875
-
1876
- </div>
1877
-
1878
-
1879
-
1880
- <div class="columns">
1881
-
1882
- <div class='param-desc column is-7'><p>If CSV is malformed</p></div>
1883
- <div class='column is-5 has-text-left'>
1884
- <label>Type: </label>
1885
- <code class="param-type"><a href="CsvFormatError.html">CsvFormatError</a></code>
1886
-
1887
-
1888
- </div>
1889
-
1890
- </div>
1891
-
1892
-
1893
- </div>
1894
- </div>
1895
-
1896
-
1897
-
1898
- <div class='columns method-parameter'>
1899
- <div class="column is-2"><label>Returns:</label></div>
1900
- <div class="column is-10">
1901
-
1902
-
1903
-
1904
- <div class="columns">
1905
-
1906
- <div class='param-desc column is-7'><p>Array of objects representing CSV rows</p></div>
1907
-
1908
-
1909
- <div class='column is-5 has-text-left'>
1910
- <label>Type: </label>
1911
-
1912
- <code class="param-type">Array.&lt;object></code>
1913
-
1914
-
1915
- </div>
1916
-
1917
- </div>
1918
-
1919
-
1920
- </div>
1921
- </div>
1922
-
1923
-
1924
-
1925
-
1926
- <h5>Example</h5>
1927
-
1928
-
1929
- <pre class="prettyprint"><code>const csvToJson = require('convert-csv-to-json');
1930
- const rows = csvToJson.getJsonFromCsv('resource/input.csv');
1931
- console.log(rows);</code></pre>
1932
-
1933
-
1934
-
1935
- </div>
1936
-
1937
- <div class="member">
1938
-
1939
-
1940
-
1941
- <h4 class="name" id="hexEncoding">
1942
- <a class="href-link" href="#hexEncoding">#</a>
1943
-
1944
- <span class="code-name">
1945
-
1946
- hexEncoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span>
1947
-
1948
- </span>
1949
- </h4>
1950
-
1951
-
1952
-
1953
-
1954
- <div class="description">
1955
- <p>Set Hex encoding for reading files</p>
1956
- </div>
1957
-
1958
-
1959
-
1960
-
1961
-
1962
-
1963
-
1964
-
1965
-
1966
-
1967
-
1968
-
1969
-
1970
-
1971
- <dl class="details">
1972
-
1973
-
1974
-
1975
-
1976
-
1977
-
1978
-
1979
-
1980
-
1981
-
1982
-
1983
-
1984
-
1985
-
1986
-
1987
-
1988
-
1989
-
1990
-
1991
-
1992
-
1993
-
1994
-
1995
-
1996
-
1997
-
1998
-
1999
-
2000
-
2001
-
2002
-
2003
- <p class="tag-source">
2004
- <a href="index.js.html" class="button">View Source</a>
2005
- <span>
2006
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line175">line 175</a>
2007
- </span>
2008
- </p>
2009
-
2010
- </dl>
2011
-
2012
-
2013
-
2014
-
2015
-
2016
-
2017
-
2018
-
2019
-
2020
-
2021
-
2022
-
2023
-
2024
-
2025
-
2026
-
2027
-
2028
-
2029
- <div class='columns method-parameter'>
2030
- <div class="column is-2"><label>Returns:</label></div>
2031
- <div class="column is-10">
2032
-
2033
-
2034
-
2035
- <div class="columns">
2036
-
2037
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
2038
-
2039
-
2040
- <div class='column is-5 has-text-left'>
2041
- <label>Type: </label>
2042
-
2043
- <code class="param-type">object</code>
2044
-
2045
-
2046
- </div>
2047
-
2048
- </div>
2049
-
2050
-
2051
- </div>
2052
- </div>
2053
-
2054
-
2055
-
2056
-
2057
- </div>
2058
-
2059
- <div class="member">
2060
-
2061
-
2062
-
2063
- <h4 class="name" id="indexHeader">
2064
- <a class="href-link" href="#indexHeader">#</a>
2065
-
2066
- <span class="code-name">
2067
-
2068
- indexHeader<span class="signature">(index)</span><span class="type-signature"> &rarr; {object}</span>
2069
-
2070
- </span>
2071
- </h4>
2072
-
2073
-
2074
-
2075
-
2076
- <div class="description">
2077
- <p>Set the row index where CSV headers are located
2078
- Use this if headers are not on the first line (row 0)</p>
2079
- </div>
2080
-
2081
-
2082
-
2083
-
2084
-
2085
-
2086
-
2087
-
2088
-
2089
-
2090
- <h5>Parameters:</h5>
2091
-
2092
- <div class="table-container">
2093
- <table class="params table">
2094
- <thead>
2095
- <tr>
2096
-
2097
- <th>Name</th>
2098
-
2099
-
2100
- <th>Type</th>
2101
-
2102
-
2103
-
2104
-
2105
-
2106
- <th class="last">Description</th>
2107
- </tr>
2108
- </thead>
2109
-
2110
- <tbody>
2111
-
2112
-
2113
-
2114
- <tr class="deep-level-0">
2115
-
2116
- <td class="name"><code>index</code></td>
2117
-
2118
-
2119
- <td class="type">
2120
-
2121
-
2122
- <code class="param-type">number</code>
2123
-
2124
-
2125
-
2126
- </td>
2127
-
2128
-
2129
-
2130
-
2131
-
2132
- <td class="description last"><p>Zero-based row index containing headers</p></td>
2133
- </tr>
2134
-
2135
-
2136
-
2137
- </tbody>
2138
- </table>
2139
- </div>
2140
-
2141
-
2142
-
2143
-
2144
-
2145
- <dl class="details">
2146
-
2147
-
2148
-
2149
-
2150
-
2151
-
2152
-
2153
-
2154
-
2155
-
2156
-
2157
-
2158
-
2159
-
2160
-
2161
-
2162
-
2163
-
2164
-
2165
-
2166
-
2167
-
2168
-
2169
-
2170
-
2171
-
2172
-
2173
-
2174
-
2175
-
2176
-
2177
- <p class="tag-source">
2178
- <a href="index.js.html" class="button">View Source</a>
2179
- <span>
2180
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line76">line 76</a>
2181
- </span>
2182
- </p>
2183
-
2184
- </dl>
2185
-
2186
-
2187
-
2188
-
2189
-
2190
-
2191
-
2192
-
2193
-
2194
-
2195
-
2196
-
2197
-
2198
-
2199
-
2200
-
2201
-
2202
-
2203
- <div class='columns method-parameter'>
2204
- <div class="column is-2"><label>Returns:</label></div>
2205
- <div class="column is-10">
2206
-
2207
-
2208
-
2209
- <div class="columns">
2210
-
2211
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
2212
-
2213
-
2214
- <div class='column is-5 has-text-left'>
2215
- <label>Type: </label>
2216
-
2217
- <code class="param-type">object</code>
2218
-
2219
-
2220
- </div>
2221
-
2222
- </div>
2223
-
2224
-
2225
- </div>
2226
- </div>
2227
-
2228
-
2229
-
2230
-
2231
- </div>
2232
-
2233
- <div class="member">
2234
-
2235
-
2236
-
2237
- <h4 class="name" id="latin1Encoding">
2238
- <a class="href-link" href="#latin1Encoding">#</a>
2239
-
2240
- <span class="code-name">
2241
-
2242
- latin1Encoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span>
2243
-
2244
- </span>
2245
- </h4>
2246
-
2247
-
2248
-
2249
-
2250
- <div class="description">
2251
- <p>Set Latin-1 (ISO-8859-1) encoding for reading files</p>
2252
- </div>
2253
-
2254
-
2255
-
2256
-
2257
-
2258
-
2259
-
2260
-
2261
-
2262
-
2263
-
2264
-
2265
-
2266
-
2267
- <dl class="details">
2268
-
2269
-
2270
-
2271
-
2272
-
2273
-
2274
-
2275
-
2276
-
2277
-
2278
-
2279
-
2280
-
2281
-
2282
-
2283
-
2284
-
2285
-
2286
-
2287
-
2288
-
2289
-
2290
-
2291
-
2292
-
2293
-
2294
-
2295
-
2296
-
2297
-
2298
-
2299
- <p class="tag-source">
2300
- <a href="index.js.html" class="button">View Source</a>
2301
- <span>
2302
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line145">line 145</a>
2303
- </span>
2304
- </p>
2305
-
2306
- </dl>
2307
-
2308
-
2309
-
2310
-
2311
-
2312
-
2313
-
2314
-
2315
-
2316
-
2317
-
2318
-
2319
-
2320
-
2321
-
2322
-
2323
-
2324
-
2325
- <div class='columns method-parameter'>
2326
- <div class="column is-2"><label>Returns:</label></div>
2327
- <div class="column is-10">
2328
-
2329
-
2330
-
2331
- <div class="columns">
2332
-
2333
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
2334
-
2335
-
2336
- <div class='column is-5 has-text-left'>
2337
- <label>Type: </label>
2338
-
2339
- <code class="param-type">object</code>
2340
-
2341
-
2342
- </div>
2343
-
2344
- </div>
2345
-
2346
-
2347
- </div>
2348
- </div>
2349
-
2350
-
2351
-
2352
-
2353
- </div>
2354
-
2355
- <div class="member">
2356
-
2357
-
2358
-
2359
- <h4 class="name" id="mapRows">
2360
- <a class="href-link" href="#mapRows">#</a>
2361
-
2362
- <span class="code-name">
2363
-
2364
- mapRows<span class="signature">(mapperFn)</span><span class="type-signature"> &rarr; {object}</span>
2365
-
2366
- </span>
2367
- </h4>
2368
-
2369
-
2370
-
2371
-
2372
- <div class="description">
2373
- <p>Set a mapper function to transform each row after conversion
2374
- The mapper function receives (row, index) where row is the JSON object
2375
- and index is the 0-based row number. Return null/undefined to filter out rows.</p>
2376
- </div>
2377
-
2378
-
2379
-
2380
-
2381
-
2382
-
2383
-
2384
-
2385
-
2386
-
2387
- <h5>Parameters:</h5>
2388
-
2389
- <div class="table-container">
2390
- <table class="params table">
2391
- <thead>
2392
- <tr>
2393
-
2394
- <th>Name</th>
2395
-
2396
-
2397
- <th>Type</th>
2398
-
2399
-
2400
-
2401
-
2402
-
2403
- <th class="last">Description</th>
2404
- </tr>
2405
- </thead>
2406
-
2407
- <tbody>
2408
-
2409
-
2410
-
2411
- <tr class="deep-level-0">
2412
-
2413
- <td class="name"><code>mapperFn</code></td>
2414
-
2415
-
2416
- <td class="type">
2417
-
2418
-
2419
- <code class="param-type">function</code>
2420
-
2421
-
2422
-
2423
- </td>
2424
-
2425
-
2426
-
2427
-
2428
-
2429
- <td class="description last"><p>Function to transform each row</p></td>
2430
- </tr>
2431
-
2432
-
2433
-
2434
- </tbody>
2435
- </table>
2436
- </div>
2437
-
2438
-
2439
-
2440
-
2441
-
2442
- <dl class="details">
2443
-
2444
-
2445
-
2446
-
2447
-
2448
-
2449
-
2450
-
2451
-
2452
-
2453
-
2454
-
2455
-
2456
-
2457
-
2458
-
2459
-
2460
-
2461
-
2462
-
2463
-
2464
-
2465
-
2466
-
2467
-
2468
-
2469
-
2470
-
2471
-
2472
-
2473
-
2474
- <p class="tag-source">
2475
- <a href="index.js.html" class="button">View Source</a>
2476
- <span>
2477
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line192">line 192</a>
2478
- </span>
2479
- </p>
2480
-
2481
- </dl>
2482
-
2483
-
2484
-
2485
-
2486
-
2487
-
2488
-
2489
-
2490
-
2491
-
2492
-
2493
-
2494
-
2495
-
2496
-
2497
-
2498
-
2499
-
2500
- <div class='columns method-parameter'>
2501
- <div class="column is-2"><label>Returns:</label></div>
2502
- <div class="column is-10">
2503
-
2504
-
2505
-
2506
- <div class="columns">
2507
-
2508
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
2509
-
2510
-
2511
- <div class='column is-5 has-text-left'>
2512
- <label>Type: </label>
2513
-
2514
- <code class="param-type">object</code>
2515
-
2516
-
2517
- </div>
2518
-
2519
- </div>
2520
-
2521
-
2522
- </div>
2523
- </div>
2524
-
2525
-
2526
-
2527
-
2528
- <h5>Example</h5>
2529
-
2530
-
2531
- <pre class="prettyprint"><code>csvToJson
2532
- .mapRows((row, idx) => idx % 2 === 0 ? row : null) // Keep every other row
2533
- .getJsonFromCsv('input.csv')</code></pre>
2534
-
2535
-
2536
-
2537
- </div>
2538
-
2539
- <div class="member">
2540
-
2541
-
2542
-
2543
- <h4 class="name" id="parseSubArray">
2544
- <a class="href-link" href="#parseSubArray">#</a>
2545
-
2546
- <span class="code-name">
2547
-
2548
- parseSubArray<span class="signature">(delimiter, separator)</span><span class="type-signature"> &rarr; {object}</span>
2549
-
2550
- </span>
2551
- </h4>
2552
-
2553
-
2554
-
2555
-
2556
- <div class="description">
2557
- <p>Configure sub-array parsing for special field values
2558
- Fields bracketed by delimiter and containing separator are parsed into arrays</p>
2559
- </div>
2560
-
2561
-
2562
-
2563
-
2564
-
2565
-
2566
-
2567
-
2568
-
2569
-
2570
- <h5>Parameters:</h5>
2571
-
2572
- <div class="table-container">
2573
- <table class="params table">
2574
- <thead>
2575
- <tr>
2576
-
2577
- <th>Name</th>
2578
-
2579
-
2580
- <th>Type</th>
2581
-
2582
-
2583
-
2584
-
2585
-
2586
- <th class="last">Description</th>
2587
- </tr>
2588
- </thead>
2589
-
2590
- <tbody>
2591
-
2592
-
2593
-
2594
- <tr class="deep-level-0">
2595
-
2596
- <td class="name"><code>delimiter</code></td>
2597
-
2598
-
2599
- <td class="type">
2600
-
2601
-
2602
- <code class="param-type">string</code>
2603
-
2604
-
2605
-
2606
- </td>
2607
-
2608
-
2609
-
2610
-
2611
-
2612
- <td class="description last"><p>Bracket character (default: '*')</p></td>
2613
- </tr>
2614
-
2615
-
2616
-
2617
-
2618
-
2619
- <tr class="deep-level-0">
2620
-
2621
- <td class="name"><code>separator</code></td>
2622
-
2623
-
2624
- <td class="type">
2625
-
2626
-
2627
- <code class="param-type">string</code>
2628
-
2629
-
2630
-
2631
- </td>
2632
-
2633
-
2634
-
2635
-
2636
-
2637
- <td class="description last"><p>Item separator within brackets (default: ',')</p></td>
2638
- </tr>
2639
-
2640
-
2641
-
2642
- </tbody>
2643
- </table>
2644
- </div>
2645
-
2646
-
2647
-
2648
-
2649
-
2650
- <dl class="details">
2651
-
2652
-
2653
-
2654
-
2655
-
2656
-
2657
-
2658
-
2659
-
2660
-
2661
-
2662
-
2663
-
2664
-
2665
-
2666
-
2667
-
2668
-
2669
-
2670
-
2671
-
2672
-
2673
-
2674
-
2675
-
2676
-
2677
-
2678
-
2679
-
2680
-
2681
-
2682
- <p class="tag-source">
2683
- <a href="index.js.html" class="button">View Source</a>
2684
- <span>
2685
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line93">line 93</a>
2686
- </span>
2687
- </p>
2688
-
2689
- </dl>
2690
-
2691
-
2692
-
2693
-
2694
-
2695
-
2696
-
2697
-
2698
-
2699
-
2700
-
2701
-
2702
-
2703
-
2704
-
2705
-
2706
-
2707
-
2708
- <div class='columns method-parameter'>
2709
- <div class="column is-2"><label>Returns:</label></div>
2710
- <div class="column is-10">
2711
-
2712
-
2713
-
2714
- <div class="columns">
2715
-
2716
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
2717
-
2718
-
2719
- <div class='column is-5 has-text-left'>
2720
- <label>Type: </label>
2721
-
2722
- <code class="param-type">object</code>
2723
-
2724
-
2725
- </div>
2726
-
2727
- </div>
2728
-
2729
-
2730
- </div>
2731
- </div>
2732
-
2733
-
2734
-
2735
-
2736
- <h5>Example</h5>
2737
-
2738
-
2739
- <pre class="prettyprint"><code>// Input field: "*val1,val2,val3*"
2740
- // Output array: ["val1", "val2", "val3"]
2741
- csvToJson.parseSubArray('*', ',')</code></pre>
2742
-
2743
-
2744
-
2745
- </div>
2746
-
2747
- <div class="member">
2748
-
2749
-
2750
-
2751
- <h4 class="name" id="supportQuotedField">
2752
- <a class="href-link" href="#supportQuotedField">#</a>
2753
-
2754
- <span class="code-name">
2755
-
2756
- supportQuotedField<span class="signature">(active)</span><span class="type-signature"> &rarr; {object}</span>
2757
-
2758
- </span>
2759
- </h4>
2760
-
2761
-
2762
-
2763
-
2764
- <div class="description">
2765
- <p>Enable or disable support for RFC 4180 quoted fields
2766
- When enabled, fields wrapped in double quotes can contain delimiters and newlines</p>
2767
- </div>
2768
-
2769
-
2770
-
2771
-
2772
-
2773
-
2774
-
2775
-
2776
-
2777
-
2778
- <h5>Parameters:</h5>
2779
-
2780
- <div class="table-container">
2781
- <table class="params table">
2782
- <thead>
2783
- <tr>
2784
-
2785
- <th>Name</th>
2786
-
2787
-
2788
- <th>Type</th>
2789
-
2790
-
2791
-
2792
-
2793
-
2794
- <th class="last">Description</th>
2795
- </tr>
2796
- </thead>
2797
-
2798
- <tbody>
2799
-
2800
-
2801
-
2802
- <tr class="deep-level-0">
2803
-
2804
- <td class="name"><code>active</code></td>
2805
-
2806
-
2807
- <td class="type">
2808
-
2809
-
2810
- <code class="param-type">boolean</code>
2811
-
2812
-
2813
-
2814
- </td>
2815
-
2816
-
2817
-
2818
-
2819
-
2820
- <td class="description last"><p>Whether to support quoted fields (default: false)</p></td>
2821
- </tr>
2822
-
2823
-
2824
-
2825
- </tbody>
2826
- </table>
2827
- </div>
2828
-
2829
-
2830
-
2831
-
2832
-
2833
- <dl class="details">
2834
-
2835
-
2836
-
2837
-
2838
-
2839
-
2840
-
2841
-
2842
-
2843
-
2844
-
2845
-
2846
-
2847
-
2848
-
2849
-
2850
-
2851
-
2852
-
2853
-
2854
-
2855
-
2856
-
2857
-
2858
-
2859
-
2860
-
2861
-
2862
-
2863
-
2864
-
2865
- <p class="tag-source">
2866
- <a href="index.js.html" class="button">View Source</a>
2867
- <span>
2868
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line41">line 41</a>
2869
- </span>
2870
- </p>
2871
-
2872
- </dl>
2873
-
2874
-
2875
-
2876
-
2877
-
2878
-
2879
-
2880
-
2881
-
2882
-
2883
-
2884
-
2885
-
2886
-
2887
-
2888
-
2889
-
2890
-
2891
- <div class='columns method-parameter'>
2892
- <div class="column is-2"><label>Returns:</label></div>
2893
- <div class="column is-10">
2894
-
2895
-
2896
-
2897
- <div class="columns">
2898
-
2899
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
2900
-
2901
-
2902
- <div class='column is-5 has-text-left'>
2903
- <label>Type: </label>
2904
-
2905
- <code class="param-type">object</code>
2906
-
2907
-
2908
- </div>
2909
-
2910
- </div>
2911
-
2912
-
2913
- </div>
2914
- </div>
2915
-
2916
-
2917
-
2918
-
2919
- </div>
2920
-
2921
- <div class="member">
2922
-
2923
-
2924
-
2925
- <h4 class="name" id="trimHeaderFieldWhiteSpace">
2926
- <a class="href-link" href="#trimHeaderFieldWhiteSpace">#</a>
2927
-
2928
- <span class="code-name">
2929
-
2930
- trimHeaderFieldWhiteSpace<span class="signature">(active)</span><span class="type-signature"> &rarr; {object}</span>
2931
-
2932
- </span>
2933
- </h4>
2934
-
2935
-
2936
-
2937
-
2938
- <div class="description">
2939
- <p>Configure whitespace handling in CSV header field names
2940
- When active, removes all whitespace from header names (e.g., &quot;My Name&quot; → &quot;MyName&quot;)
2941
- When inactive, only trims leading and trailing whitespace</p>
2942
- </div>
2943
-
2944
-
2945
-
2946
-
2947
-
2948
-
2949
-
2950
-
2951
-
2952
-
2953
- <h5>Parameters:</h5>
2954
-
2955
- <div class="table-container">
2956
- <table class="params table">
2957
- <thead>
2958
- <tr>
2959
-
2960
- <th>Name</th>
2961
-
2962
-
2963
- <th>Type</th>
2964
-
2965
-
2966
-
2967
-
2968
-
2969
- <th class="last">Description</th>
2970
- </tr>
2971
- </thead>
2972
-
2973
- <tbody>
2974
-
2975
-
2976
-
2977
- <tr class="deep-level-0">
2978
-
2979
- <td class="name"><code>active</code></td>
2980
-
2981
-
2982
- <td class="type">
2983
-
2984
-
2985
- <code class="param-type">boolean</code>
2986
-
2987
-
2988
-
2989
- </td>
2990
-
2991
-
2992
-
2993
-
2994
-
2995
- <td class="description last"><p>Whether to remove all whitespace from headers (default: false)</p></td>
2996
- </tr>
2997
-
2998
-
2999
-
3000
- </tbody>
3001
- </table>
3002
- </div>
3003
-
3004
-
3005
-
3006
-
3007
-
3008
- <dl class="details">
3009
-
3010
-
3011
-
3012
-
3013
-
3014
-
3015
-
3016
-
3017
-
3018
-
3019
-
3020
-
3021
-
3022
-
3023
-
3024
-
3025
-
3026
-
3027
-
3028
-
3029
-
3030
-
3031
-
3032
-
3033
-
3034
-
3035
-
3036
-
3037
-
3038
-
3039
-
3040
- <p class="tag-source">
3041
- <a href="index.js.html" class="button">View Source</a>
3042
- <span>
3043
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line64">line 64</a>
3044
- </span>
3045
- </p>
3046
-
3047
- </dl>
3048
-
3049
-
3050
-
3051
-
3052
-
3053
-
3054
-
3055
-
3056
-
3057
-
3058
-
3059
-
3060
-
3061
-
3062
-
3063
-
3064
-
3065
-
3066
- <div class='columns method-parameter'>
3067
- <div class="column is-2"><label>Returns:</label></div>
3068
- <div class="column is-10">
3069
-
3070
-
3071
-
3072
- <div class="columns">
3073
-
3074
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
3075
-
3076
-
3077
- <div class='column is-5 has-text-left'>
3078
- <label>Type: </label>
3079
-
3080
- <code class="param-type">object</code>
3081
-
3082
-
3083
- </div>
3084
-
3085
- </div>
3086
-
3087
-
3088
- </div>
3089
- </div>
3090
-
3091
-
3092
-
3093
-
3094
- </div>
3095
-
3096
- <div class="member">
3097
-
3098
-
3099
-
3100
- <h4 class="name" id="ucs2Encoding">
3101
- <a class="href-link" href="#ucs2Encoding">#</a>
3102
-
3103
- <span class="code-name">
3104
-
3105
- ucs2Encoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span>
3106
-
3107
- </span>
3108
- </h4>
3109
-
3110
-
3111
-
3112
-
3113
- <div class="description">
3114
- <p>Set UCS-2 encoding for reading files</p>
3115
- </div>
3116
-
3117
-
3118
-
3119
-
3120
-
3121
-
3122
-
3123
-
3124
-
3125
-
3126
-
3127
-
3128
-
3129
-
3130
- <dl class="details">
3131
-
3132
-
3133
-
3134
-
3135
-
3136
-
3137
-
3138
-
3139
-
3140
-
3141
-
3142
-
3143
-
3144
-
3145
-
3146
-
3147
-
3148
-
3149
-
3150
-
3151
-
3152
-
3153
-
3154
-
3155
-
3156
-
3157
-
3158
-
3159
-
3160
-
3161
-
3162
- <p class="tag-source">
3163
- <a href="index.js.html" class="button">View Source</a>
3164
- <span>
3165
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line125">line 125</a>
3166
- </span>
3167
- </p>
3168
-
3169
- </dl>
3170
-
3171
-
3172
-
3173
-
3174
-
3175
-
3176
-
3177
-
3178
-
3179
-
3180
-
3181
-
3182
-
3183
-
3184
-
3185
-
3186
-
3187
-
3188
- <div class='columns method-parameter'>
3189
- <div class="column is-2"><label>Returns:</label></div>
3190
- <div class="column is-10">
3191
-
3192
-
3193
-
3194
- <div class="columns">
3195
-
3196
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
3197
-
3198
-
3199
- <div class='column is-5 has-text-left'>
3200
- <label>Type: </label>
3201
-
3202
- <code class="param-type">object</code>
3203
-
3204
-
3205
- </div>
3206
-
3207
- </div>
3208
-
3209
-
3210
- </div>
3211
- </div>
3212
-
3213
-
3214
-
3215
-
3216
- </div>
3217
-
3218
- <div class="member">
3219
-
3220
-
3221
-
3222
- <h4 class="name" id="utf16leEncoding">
3223
- <a class="href-link" href="#utf16leEncoding">#</a>
3224
-
3225
- <span class="code-name">
3226
-
3227
- utf16leEncoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span>
3228
-
3229
- </span>
3230
- </h4>
3231
-
3232
-
3233
-
3234
-
3235
- <div class="description">
3236
- <p>Set UTF-16 LE encoding for reading files</p>
3237
- </div>
3238
-
3239
-
3240
-
3241
-
3242
-
3243
-
3244
-
3245
-
3246
-
3247
-
3248
-
3249
-
3250
-
3251
-
3252
- <dl class="details">
3253
-
3254
-
3255
-
3256
-
3257
-
3258
-
3259
-
3260
-
3261
-
3262
-
3263
-
3264
-
3265
-
3266
-
3267
-
3268
-
3269
-
3270
-
3271
-
3272
-
3273
-
3274
-
3275
-
3276
-
3277
-
3278
-
3279
-
3280
-
3281
-
3282
-
3283
-
3284
- <p class="tag-source">
3285
- <a href="index.js.html" class="button">View Source</a>
3286
- <span>
3287
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line135">line 135</a>
3288
- </span>
3289
- </p>
3290
-
3291
- </dl>
3292
-
3293
-
3294
-
3295
-
3296
-
3297
-
3298
-
3299
-
3300
-
3301
-
3302
-
3303
-
3304
-
3305
-
3306
-
3307
-
3308
-
3309
-
3310
- <div class='columns method-parameter'>
3311
- <div class="column is-2"><label>Returns:</label></div>
3312
- <div class="column is-10">
3313
-
3314
-
3315
-
3316
- <div class="columns">
3317
-
3318
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
3319
-
3320
-
3321
- <div class='column is-5 has-text-left'>
3322
- <label>Type: </label>
3323
-
3324
- <code class="param-type">object</code>
3325
-
3326
-
3327
- </div>
3328
-
3329
- </div>
3330
-
3331
-
3332
- </div>
3333
- </div>
3334
-
3335
-
3336
-
3337
-
3338
- </div>
3339
-
3340
- <div class="member">
3341
-
3342
-
3343
-
3344
- <h4 class="name" id="utf8Encoding">
3345
- <a class="href-link" href="#utf8Encoding">#</a>
3346
-
3347
- <span class="code-name">
3348
-
3349
- utf8Encoding<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span>
3350
-
3351
- </span>
3352
- </h4>
3353
-
3354
-
3355
-
3356
-
3357
- <div class="description">
3358
- <p>Set UTF-8 encoding (default encoding)</p>
3359
- </div>
3360
-
3361
-
3362
-
3363
-
3364
-
3365
-
3366
-
3367
-
3368
-
3369
-
3370
-
3371
-
3372
-
3373
-
3374
- <dl class="details">
3375
-
3376
-
3377
-
3378
-
3379
-
3380
-
3381
-
3382
-
3383
-
3384
-
3385
-
3386
-
3387
-
3388
-
3389
-
3390
-
3391
-
3392
-
3393
-
3394
-
3395
-
3396
-
3397
-
3398
-
3399
-
3400
-
3401
-
3402
-
3403
-
3404
-
3405
-
3406
- <p class="tag-source">
3407
- <a href="index.js.html" class="button">View Source</a>
3408
- <span>
3409
- <a href="index.js.html">index.js</a>, <a href="index.js.html#line115">line 115</a>
3410
- </span>
3411
- </p>
3412
-
3413
- </dl>
3414
-
3415
-
3416
-
3417
-
3418
-
3419
-
3420
-
3421
-
3422
-
3423
-
3424
-
3425
-
3426
-
3427
-
3428
-
3429
-
3430
-
3431
-
3432
- <div class='columns method-parameter'>
3433
- <div class="column is-2"><label>Returns:</label></div>
3434
- <div class="column is-10">
3435
-
3436
-
3437
-
3438
- <div class="columns">
3439
-
3440
- <div class='param-desc column is-7'><p>Module context for method chaining</p></div>
3441
-
3442
-
3443
- <div class='column is-5 has-text-left'>
3444
- <label>Type: </label>
3445
-
3446
- <code class="param-type">object</code>
3447
-
3448
-
3449
- </div>
3450
-
3451
- </div>
3452
-
3453
-
3454
- </div>
3455
- </div>
3456
-
3457
-
3458
-
3459
-
3460
- </div>
3461
-
3462
- </div>
3463
- </div>
3464
-
3465
-
3466
-
3467
-
3468
-
3469
- </article>
3470
-
3471
- </section>
3472
-
3473
-
3474
-
3475
-
3476
- </div>
3477
-
3478
- <footer class="footer">
3479
- <div class="content has-text-centered">
3480
- <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a></p>
3481
- <p class="sidebar-created-by">
3482
- <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
3483
- <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
3484
- </p>
3485
- </div>
3486
- </footer>
3487
-
3488
- </div>
3489
- <div id="side-nav" class="side-nav">
3490
- </div>
3491
- </div>
3492
- <script src="scripts/app.min.js"></script>
3493
- <script>PR.prettyPrint();</script>
3494
- <script src="scripts/linenumber.js"> </script>
3495
-
3496
-
3497
- </body>
3498
- </html>