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.
- package/.github/workflows/ci-cd.yml +1 -1
- package/docs/.nojekyll +0 -0
- package/docs/README.md +44 -0
- package/docs/demo.bundle.js +1708 -0
- package/docs/index.html +536 -0
- package/eslint.config.js +1 -1
- package/package.json +5 -1
- package/docs/api/BrowserApi.html +0 -2662
- package/docs/api/BrowserApiError.html +0 -669
- package/docs/api/ConfigurationError.html +0 -745
- package/docs/api/CsvFormatError.html +0 -677
- package/docs/api/CsvParsingError.html +0 -511
- package/docs/api/CsvToJson.html +0 -3367
- package/docs/api/CsvToJsonAsync.html +0 -2880
- package/docs/api/FileOperationError.html +0 -382
- package/docs/api/FileUtils.html +0 -1150
- package/docs/api/InputValidationError.html +0 -407
- package/docs/api/JsonUtil.html +0 -452
- package/docs/api/JsonValidationError.html +0 -357
- package/docs/api/StringUtils.html +0 -833
- package/docs/api/global.html +0 -3498
- package/docs/api/index.html +0 -414
- package/docs/api/index.js.html +0 -447
- package/docs/api/scripts/app.min.js +0 -1
- package/docs/api/scripts/linenumber.js +0 -26
- package/docs/api/scripts/search.js +0 -39
- package/docs/api/src_browserApi.js.html +0 -362
- package/docs/api/src_csvToJson.js.html +0 -696
- package/docs/api/src_csvToJsonAsync.js.html +0 -335
- package/docs/api/src_util_errors.js.html +0 -472
- package/docs/api/src_util_fileUtils.js.html +0 -238
- package/docs/api/src_util_jsonUtils.js.html +0 -166
- package/docs/api/src_util_stringUtils.js.html +0 -306
- package/docs/api/styles/app.min.css +0 -1
- package/docs/api/styles/iframe.css +0 -13
- package/docs/api/styles/prettify-jsdoc.css +0 -111
- package/docs/api/styles/prettify-tomorrow.css +0 -132
- package/docs/api/styles/reset.css +0 -44
package/docs/api/FileUtils.html
DELETED
|
@@ -1,1150 +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> FileUtils</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>Class</p>
|
|
101
|
-
<h1>FileUtils</h1>
|
|
102
|
-
</header>
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
<section>
|
|
109
|
-
|
|
110
|
-
<header>
|
|
111
|
-
|
|
112
|
-
<h2><span class="attribs"><span class="type-signature"></span></span>FileUtils<span class="signature">()</span><span class="type-signature"></span></h2>
|
|
113
|
-
|
|
114
|
-
<div class="class-description"><p>File I/O utilities for reading and writing CSV/JSON files
|
|
115
|
-
Provides both synchronous and asynchronous file operations</p></div>
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
</header>
|
|
119
|
-
|
|
120
|
-
<article>
|
|
121
|
-
<div class="container-overview">
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
<div class='vertical-section'>
|
|
125
|
-
<div class="members">
|
|
126
|
-
<div class="member">
|
|
127
|
-
<div class=name>
|
|
128
|
-
<span class="tag">Constructor</span>
|
|
129
|
-
</div>
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
<h4 class="name" id="FileUtils">
|
|
135
|
-
<a class="href-link" href="#FileUtils">#</a>
|
|
136
|
-
|
|
137
|
-
<span class="code-name">
|
|
138
|
-
|
|
139
|
-
new FileUtils<span class="signature">()</span><span class="type-signature"></span>
|
|
140
|
-
|
|
141
|
-
</span>
|
|
142
|
-
</h4>
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
<dl class="details">
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
<p class="tag-source">
|
|
193
|
-
<a href="src_util_fileUtils.js.html" class="button">View Source</a>
|
|
194
|
-
<span>
|
|
195
|
-
<a href="src_util_fileUtils.js.html">src/util/fileUtils.js</a>, <a href="src_util_fileUtils.js.html#line11">line 11</a>
|
|
196
|
-
</span>
|
|
197
|
-
</p>
|
|
198
|
-
|
|
199
|
-
</dl>
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
</div>
|
|
223
|
-
</div>
|
|
224
|
-
</div>
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
</div>
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
<div class='vertical-section'>
|
|
245
|
-
<h1>Methods</h1>
|
|
246
|
-
<div class="members">
|
|
247
|
-
|
|
248
|
-
<div class="member">
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
<h4 class="name" id="readFile">
|
|
253
|
-
<a class="href-link" href="#readFile">#</a>
|
|
254
|
-
|
|
255
|
-
<span class="code-name">
|
|
256
|
-
|
|
257
|
-
readFile<span class="signature">(fileInputName, encoding)</span><span class="type-signature"> → {string}</span>
|
|
258
|
-
|
|
259
|
-
</span>
|
|
260
|
-
</h4>
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
<div class="description">
|
|
266
|
-
<p>Read a file synchronously with specified encoding</p>
|
|
267
|
-
</div>
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
<h5>Parameters:</h5>
|
|
279
|
-
|
|
280
|
-
<div class="table-container">
|
|
281
|
-
<table class="params table">
|
|
282
|
-
<thead>
|
|
283
|
-
<tr>
|
|
284
|
-
|
|
285
|
-
<th>Name</th>
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
<th>Type</th>
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
<th class="last">Description</th>
|
|
295
|
-
</tr>
|
|
296
|
-
</thead>
|
|
297
|
-
|
|
298
|
-
<tbody>
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
<tr class="deep-level-0">
|
|
303
|
-
|
|
304
|
-
<td class="name"><code>fileInputName</code></td>
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
<td class="type">
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
<code class="param-type">string</code>
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
</td>
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
<td class="description last"><p>Path to file to read</p></td>
|
|
321
|
-
</tr>
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
<tr class="deep-level-0">
|
|
328
|
-
|
|
329
|
-
<td class="name"><code>encoding</code></td>
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
<td class="type">
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
<code class="param-type">string</code>
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
</td>
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
<td class="description last"><p>File encoding (e.g., 'utf8', 'latin1')</p></td>
|
|
346
|
-
</tr>
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
</tbody>
|
|
351
|
-
</table>
|
|
352
|
-
</div>
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
<dl class="details">
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
<p class="tag-source">
|
|
391
|
-
<a href="src_util_fileUtils.js.html" class="button">View Source</a>
|
|
392
|
-
<span>
|
|
393
|
-
<a href="src_util_fileUtils.js.html">src/util/fileUtils.js</a>, <a href="src_util_fileUtils.js.html#line20">line 20</a>
|
|
394
|
-
</span>
|
|
395
|
-
</p>
|
|
396
|
-
|
|
397
|
-
</dl>
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
<div class='columns method-parameter'>
|
|
415
|
-
<div class="column is-2"><label>Throws:</label></div>
|
|
416
|
-
<div class="column is-10">
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
<div class="columns">
|
|
420
|
-
|
|
421
|
-
<div class='param-desc column is-7'><p>If file read fails</p></div>
|
|
422
|
-
<div class='column is-5 has-text-left'>
|
|
423
|
-
<label>Type: </label>
|
|
424
|
-
<code class="param-type"><a href="FileOperationError.html">FileOperationError</a></code>
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
</div>
|
|
428
|
-
|
|
429
|
-
</div>
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
</div>
|
|
433
|
-
</div>
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
<div class='columns method-parameter'>
|
|
438
|
-
<div class="column is-2"><label>Returns:</label></div>
|
|
439
|
-
<div class="column is-10">
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
<div class="columns">
|
|
444
|
-
|
|
445
|
-
<div class='param-desc column is-7'><p>File contents as string</p></div>
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
<div class='column is-5 has-text-left'>
|
|
449
|
-
<label>Type: </label>
|
|
450
|
-
|
|
451
|
-
<code class="param-type">string</code>
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
</div>
|
|
455
|
-
|
|
456
|
-
</div>
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
</div>
|
|
460
|
-
</div>
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
</div>
|
|
466
|
-
|
|
467
|
-
<div class="member">
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
<h4 class="name" id="readFileAsync">
|
|
472
|
-
<a class="href-link" href="#readFileAsync">#</a>
|
|
473
|
-
|
|
474
|
-
<span class="code-name">
|
|
475
|
-
|
|
476
|
-
readFileAsync<span class="signature">(fileInputName, encoding)</span><span class="type-signature"> → {Promise.<string>}</span>
|
|
477
|
-
|
|
478
|
-
</span>
|
|
479
|
-
</h4>
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
<div class="description">
|
|
485
|
-
<p>Read a file asynchronously with specified encoding
|
|
486
|
-
Uses fs.promises when available, falls back to callback-based API</p>
|
|
487
|
-
</div>
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
<h5>Parameters:</h5>
|
|
499
|
-
|
|
500
|
-
<div class="table-container">
|
|
501
|
-
<table class="params table">
|
|
502
|
-
<thead>
|
|
503
|
-
<tr>
|
|
504
|
-
|
|
505
|
-
<th>Name</th>
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
<th>Type</th>
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
<th>Default</th>
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
<th class="last">Description</th>
|
|
517
|
-
</tr>
|
|
518
|
-
</thead>
|
|
519
|
-
|
|
520
|
-
<tbody>
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
<tr class="deep-level-0">
|
|
525
|
-
|
|
526
|
-
<td class="name"><code>fileInputName</code></td>
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
<td class="type">
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
<code class="param-type">string</code>
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
</td>
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
<td class="default">
|
|
542
|
-
|
|
543
|
-
</td>
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
<td class="description last"><p>Path to file to read</p></td>
|
|
547
|
-
</tr>
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
<tr class="deep-level-0">
|
|
554
|
-
|
|
555
|
-
<td class="name"><code>encoding</code></td>
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
<td class="type">
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
<code class="param-type">string</code>
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
</td>
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
<td class="default">
|
|
571
|
-
|
|
572
|
-
utf8
|
|
573
|
-
|
|
574
|
-
</td>
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
<td class="description last"><p>File encoding (default: 'utf8')</p></td>
|
|
578
|
-
</tr>
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
</tbody>
|
|
583
|
-
</table>
|
|
584
|
-
</div>
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
<dl class="details">
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
<p class="tag-source">
|
|
623
|
-
<a href="src_util_fileUtils.js.html" class="button">View Source</a>
|
|
624
|
-
<span>
|
|
625
|
-
<a href="src_util_fileUtils.js.html">src/util/fileUtils.js</a>, <a href="src_util_fileUtils.js.html#line36">line 36</a>
|
|
626
|
-
</span>
|
|
627
|
-
</p>
|
|
628
|
-
|
|
629
|
-
</dl>
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
<div class='columns method-parameter'>
|
|
647
|
-
<div class="column is-2"><label>Throws:</label></div>
|
|
648
|
-
<div class="column is-10">
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
<div class="columns">
|
|
652
|
-
|
|
653
|
-
<div class='param-desc column is-7'><p>If file read fails</p></div>
|
|
654
|
-
<div class='column is-5 has-text-left'>
|
|
655
|
-
<label>Type: </label>
|
|
656
|
-
<code class="param-type"><a href="FileOperationError.html">FileOperationError</a></code>
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
</div>
|
|
660
|
-
|
|
661
|
-
</div>
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
</div>
|
|
665
|
-
</div>
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
<div class='columns method-parameter'>
|
|
670
|
-
<div class="column is-2"><label>Returns:</label></div>
|
|
671
|
-
<div class="column is-10">
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
<div class="columns">
|
|
676
|
-
|
|
677
|
-
<div class='param-desc column is-7'><p>Promise resolving to file contents</p></div>
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
<div class='column is-5 has-text-left'>
|
|
681
|
-
<label>Type: </label>
|
|
682
|
-
|
|
683
|
-
<code class="param-type">Promise.<string></code>
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
</div>
|
|
687
|
-
|
|
688
|
-
</div>
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
</div>
|
|
692
|
-
</div>
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
</div>
|
|
698
|
-
|
|
699
|
-
<div class="member">
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
<h4 class="name" id="writeFile">
|
|
704
|
-
<a class="href-link" href="#writeFile">#</a>
|
|
705
|
-
|
|
706
|
-
<span class="code-name">
|
|
707
|
-
|
|
708
|
-
writeFile<span class="signature">(json, fileOutputName)</span><span class="type-signature"></span>
|
|
709
|
-
|
|
710
|
-
</span>
|
|
711
|
-
</h4>
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
<div class="description">
|
|
717
|
-
<p>Write content to a file synchronously
|
|
718
|
-
Logs confirmation message to console on success</p>
|
|
719
|
-
</div>
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
<h5>Parameters:</h5>
|
|
731
|
-
|
|
732
|
-
<div class="table-container">
|
|
733
|
-
<table class="params table">
|
|
734
|
-
<thead>
|
|
735
|
-
<tr>
|
|
736
|
-
|
|
737
|
-
<th>Name</th>
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
<th>Type</th>
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
<th class="last">Description</th>
|
|
747
|
-
</tr>
|
|
748
|
-
</thead>
|
|
749
|
-
|
|
750
|
-
<tbody>
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
<tr class="deep-level-0">
|
|
755
|
-
|
|
756
|
-
<td class="name"><code>json</code></td>
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
<td class="type">
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
<code class="param-type">string</code>
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
</td>
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
<td class="description last"><p>Content to write to file</p></td>
|
|
773
|
-
</tr>
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
<tr class="deep-level-0">
|
|
780
|
-
|
|
781
|
-
<td class="name"><code>fileOutputName</code></td>
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
<td class="type">
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
<code class="param-type">string</code>
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
</td>
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
<td class="description last"><p>Path to output file</p></td>
|
|
798
|
-
</tr>
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
</tbody>
|
|
803
|
-
</table>
|
|
804
|
-
</div>
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
<dl class="details">
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
<p class="tag-source">
|
|
843
|
-
<a href="src_util_fileUtils.js.html" class="button">View Source</a>
|
|
844
|
-
<span>
|
|
845
|
-
<a href="src_util_fileUtils.js.html">src/util/fileUtils.js</a>, <a href="src_util_fileUtils.js.html#line63">line 63</a>
|
|
846
|
-
</span>
|
|
847
|
-
</p>
|
|
848
|
-
|
|
849
|
-
</dl>
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
<div class='columns method-parameter'>
|
|
867
|
-
<div class="column is-2"><label>Throws:</label></div>
|
|
868
|
-
<div class="column is-10">
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
<div class="columns">
|
|
872
|
-
|
|
873
|
-
<div class='param-desc column is-7'><p>If file write fails</p></div>
|
|
874
|
-
<div class='column is-5 has-text-left'>
|
|
875
|
-
<label>Type: </label>
|
|
876
|
-
<code class="param-type"><a href="FileOperationError.html">FileOperationError</a></code>
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
</div>
|
|
880
|
-
|
|
881
|
-
</div>
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
</div>
|
|
885
|
-
</div>
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
</div>
|
|
893
|
-
|
|
894
|
-
<div class="member">
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
<h4 class="name" id="writeFileAsync">
|
|
899
|
-
<a class="href-link" href="#writeFileAsync">#</a>
|
|
900
|
-
|
|
901
|
-
<span class="code-name">
|
|
902
|
-
|
|
903
|
-
writeFileAsync<span class="signature">(json, fileOutputName)</span><span class="type-signature"> → {Promise.<void>}</span>
|
|
904
|
-
|
|
905
|
-
</span>
|
|
906
|
-
</h4>
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
<div class="description">
|
|
912
|
-
<p>Write content to a file asynchronously
|
|
913
|
-
Uses fs.promises when available, falls back to callback-based API</p>
|
|
914
|
-
</div>
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
<h5>Parameters:</h5>
|
|
926
|
-
|
|
927
|
-
<div class="table-container">
|
|
928
|
-
<table class="params table">
|
|
929
|
-
<thead>
|
|
930
|
-
<tr>
|
|
931
|
-
|
|
932
|
-
<th>Name</th>
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
<th>Type</th>
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
<th class="last">Description</th>
|
|
942
|
-
</tr>
|
|
943
|
-
</thead>
|
|
944
|
-
|
|
945
|
-
<tbody>
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
<tr class="deep-level-0">
|
|
950
|
-
|
|
951
|
-
<td class="name"><code>json</code></td>
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
<td class="type">
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
<code class="param-type">string</code>
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
</td>
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
<td class="description last"><p>Content to write to file</p></td>
|
|
968
|
-
</tr>
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
<tr class="deep-level-0">
|
|
975
|
-
|
|
976
|
-
<td class="name"><code>fileOutputName</code></td>
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
<td class="type">
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
<code class="param-type">string</code>
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
</td>
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
<td class="description last"><p>Path to output file</p></td>
|
|
993
|
-
</tr>
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
</tbody>
|
|
998
|
-
</table>
|
|
999
|
-
</div>
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
<dl class="details">
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
<p class="tag-source">
|
|
1038
|
-
<a href="src_util_fileUtils.js.html" class="button">View Source</a>
|
|
1039
|
-
<span>
|
|
1040
|
-
<a href="src_util_fileUtils.js.html">src/util/fileUtils.js</a>, <a href="src_util_fileUtils.js.html#line81">line 81</a>
|
|
1041
|
-
</span>
|
|
1042
|
-
</p>
|
|
1043
|
-
|
|
1044
|
-
</dl>
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
<div class='columns method-parameter'>
|
|
1062
|
-
<div class="column is-2"><label>Throws:</label></div>
|
|
1063
|
-
<div class="column is-10">
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
<div class="columns">
|
|
1067
|
-
|
|
1068
|
-
<div class='param-desc column is-7'><p>If file write fails</p></div>
|
|
1069
|
-
<div class='column is-5 has-text-left'>
|
|
1070
|
-
<label>Type: </label>
|
|
1071
|
-
<code class="param-type"><a href="FileOperationError.html">FileOperationError</a></code>
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
</div>
|
|
1075
|
-
|
|
1076
|
-
</div>
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
</div>
|
|
1080
|
-
</div>
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
<div class='columns method-parameter'>
|
|
1085
|
-
<div class="column is-2"><label>Returns:</label></div>
|
|
1086
|
-
<div class="column is-10">
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
<div class="columns">
|
|
1091
|
-
|
|
1092
|
-
<div class='param-desc column is-7'><p>Promise that resolves when write completes</p></div>
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
<div class='column is-5 has-text-left'>
|
|
1096
|
-
<label>Type: </label>
|
|
1097
|
-
|
|
1098
|
-
<code class="param-type">Promise.<void></code>
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
</div>
|
|
1102
|
-
|
|
1103
|
-
</div>
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
</div>
|
|
1107
|
-
</div>
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
</div>
|
|
1113
|
-
|
|
1114
|
-
</div>
|
|
1115
|
-
</div>
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
</article>
|
|
1122
|
-
|
|
1123
|
-
</section>
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
</div>
|
|
1129
|
-
|
|
1130
|
-
<footer class="footer">
|
|
1131
|
-
<div class="content has-text-centered">
|
|
1132
|
-
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a></p>
|
|
1133
|
-
<p class="sidebar-created-by">
|
|
1134
|
-
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
|
|
1135
|
-
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
|
|
1136
|
-
</p>
|
|
1137
|
-
</div>
|
|
1138
|
-
</footer>
|
|
1139
|
-
|
|
1140
|
-
</div>
|
|
1141
|
-
<div id="side-nav" class="side-nav">
|
|
1142
|
-
</div>
|
|
1143
|
-
</div>
|
|
1144
|
-
<script src="scripts/app.min.js"></script>
|
|
1145
|
-
<script>PR.prettyPrint();</script>
|
|
1146
|
-
<script src="scripts/linenumber.js"> </script>
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
</body>
|
|
1150
|
-
</html>
|