Skip to content

Commit 5572709

Browse files
ashleydavisashleydavis
committed
Updated api docs.
1 parent 13b9095 commit 5572709

File tree

5 files changed

+30
-12
lines changed

5 files changed

+30
-12
lines changed

‎docs/index.html‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h3>asCSV</h3>
9696
<li class="tsd-description">
9797
<aside class="tsd-sources">
9898
<ul>
99-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L345">index.ts:345</a></li>
99+
<li>Defined in index.ts:370</li>
100100
</ul>
101101
</aside>
102102
<div class="tsd-comment tsd-typography">
@@ -115,6 +115,13 @@ <h3>asCSV</h3>
115115
<dd><pre>
116116

117117
await df.asCSV().writeFile("my-data-file.csv");
118+
</pre>
119+
</dd>
120+
<dt>example</dt>
121+
<dd><pre>
122+
123+
const options = { ... };
124+
await df.asCSV(options).writeFile("my-data-file.csv");
118125
</pre>
119126
</dd>
120127
</dl>
@@ -135,6 +142,9 @@ <h5>this: <span class="tsd-signature-type">IDataFrame</span><span class="tsd-sig
135142
</li>
136143
<li>
137144
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">ICSVOutputOptions</span></h5>
145+
<div class="tsd-comment tsd-typography">
146+
<p>Options for CSV output. The options object is passed directly to <a href="https://www.papaparse.com/docs#unparse">PapaParse.unparse</a>, please see <a href="https://www.papaparse.com/docs#unparse-config-default">PapaParse docs for additional options</a>.</p>
147+
</div>
138148
</li>
139149
</ul>
140150
<h4 class="tsd-returns-title">Returns <a href="interfaces/icsvserializer.html" class="tsd-signature-type">ICsvSerializer</a></h4>
@@ -152,7 +162,7 @@ <h3>asJSON</h3>
152162
<li class="tsd-description">
153163
<aside class="tsd-sources">
154164
<ul>
155-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L367">index.ts:367</a></li>
165+
<li>Defined in index.ts:392</li>
156166
</ul>
157167
</aside>
158168
<div class="tsd-comment tsd-typography">
@@ -205,7 +215,7 @@ <h3>read<wbr>File</h3>
205215
<li class="tsd-description">
206216
<aside class="tsd-sources">
207217
<ul>
208-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L701">index.ts:701</a></li>
218+
<li>Defined in index.ts:728</li>
209219
</ul>
210220
</aside>
211221
<div class="tsd-comment tsd-typography">
@@ -261,7 +271,7 @@ <h3>read<wbr>File<wbr>Sync</h3>
261271
<li class="tsd-description">
262272
<aside class="tsd-sources">
263273
<ul>
264-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L739">index.ts:739</a></li>
274+
<li>Defined in index.ts:766</li>
265275
</ul>
266276
</aside>
267277
<div class="tsd-comment tsd-typography">

‎docs/interfaces/iasyncfilereader.html‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h3>parseCSV</h3>
103103
<li class="tsd-description">
104104
<aside class="tsd-sources">
105105
<ul>
106-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L419">index.ts:419</a></li>
106+
<li>Defined in index.ts:445</li>
107107
</ul>
108108
</aside>
109109
<div class="tsd-comment tsd-typography">
@@ -133,6 +133,10 @@ <h4 class="tsd-parameters-title">Parameters</h4>
133133
<ul class="tsd-parameters">
134134
<li>
135135
<h5><span class="tsd-flag ts-flagOptional">Optional</span> config: <span class="tsd-signature-type">ICSVOptions</span></h5>
136+
<div class="tsd-comment tsd-typography">
137+
<p>Optional configuration file for parsing.
138+
The config object is passed directly to <a href="https://www.papaparse.com/docs#strings">PapaParse.parse</a>, please see <a href="https://www.papaparse.com/docs#config">PapaParse docs for additional options</a>.</p>
139+
</div>
136140
</li>
137141
</ul>
138142
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IDataFrame</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -150,7 +154,7 @@ <h3>parseJSON</h3>
150154
<li class="tsd-description">
151155
<aside class="tsd-sources">
152156
<ul>
153-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L433">index.ts:433</a></li>
157+
<li>Defined in index.ts:459</li>
154158
</ul>
155159
</aside>
156160
<div class="tsd-comment tsd-typography">

‎docs/interfaces/icsvserializer.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h3>write<wbr>File</h3>
103103
<li class="tsd-description">
104104
<aside class="tsd-sources">
105105
<ul>
106-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L26">index.ts:26</a></li>
106+
<li>Defined in index.ts:26</li>
107107
</ul>
108108
</aside>
109109
<div class="tsd-comment tsd-typography">
@@ -144,7 +144,7 @@ <h3>write<wbr>File<wbr>Sync</h3>
144144
<li class="tsd-description">
145145
<aside class="tsd-sources">
146146
<ul>
147-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L40">index.ts:40</a></li>
147+
<li>Defined in index.ts:40</li>
148148
</ul>
149149
</aside>
150150
<div class="tsd-comment tsd-typography">

‎docs/interfaces/ijsonserializer.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h3>write<wbr>File</h3>
103103
<li class="tsd-description">
104104
<aside class="tsd-sources">
105105
<ul>
106-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L129">index.ts:129</a></li>
106+
<li>Defined in index.ts:129</li>
107107
</ul>
108108
</aside>
109109
<div class="tsd-comment tsd-typography">
@@ -144,7 +144,7 @@ <h3>write<wbr>File<wbr>Sync</h3>
144144
<li class="tsd-description">
145145
<aside class="tsd-sources">
146146
<ul>
147-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L143">index.ts:143</a></li>
147+
<li>Defined in index.ts:143</li>
148148
</ul>
149149
</aside>
150150
<div class="tsd-comment tsd-typography">

‎docs/interfaces/isyncfilereader.html‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h3>parseCSV</h3>
103103
<li class="tsd-description">
104104
<aside class="tsd-sources">
105105
<ul>
106-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L525">index.ts:525</a></li>
106+
<li>Defined in index.ts:553</li>
107107
</ul>
108108
</aside>
109109
<div class="tsd-comment tsd-typography">
@@ -132,6 +132,10 @@ <h4 class="tsd-parameters-title">Parameters</h4>
132132
<ul class="tsd-parameters">
133133
<li>
134134
<h5><span class="tsd-flag ts-flagOptional">Optional</span> config: <span class="tsd-signature-type">ICSVOptions</span></h5>
135+
<div class="tsd-comment tsd-typography">
136+
<p>Optional configuration file for parsing.
137+
The config object is passed directly to <a href="https://www.papaparse.com/docs#strings">PapaParse.parse</a>, please see <a href="https://www.papaparse.com/docs#config">PapaParse docs for additional options</a>.</p>
138+
</div>
135139
</li>
136140
</ul>
137141
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IDataFrame</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -149,7 +153,7 @@ <h3>parseJSON</h3>
149153
<li class="tsd-description">
150154
<aside class="tsd-sources">
151155
<ul>
152-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/463368c/src/index.ts#L538">index.ts:538</a></li>
156+
<li>Defined in index.ts:566</li>
153157
</ul>
154158
</aside>
155159
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)