Skip to content

Commit cec5cf4

Browse files
ashleydavisashleydavis
committed
Improved docs.
1 parent f1cad7b commit cec5cf4

File tree

6 files changed

+275
-13
lines changed

6 files changed

+275
-13
lines changed

‎docs/index.html‎

Lines changed: 48 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/c7a0a21/src/index.ts#L339">index.ts:339</a></li>
99+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L339">index.ts:339</a></li>
100100
</ul>
101101
</aside>
102102
<div class="tsd-comment tsd-typography">
@@ -149,7 +149,7 @@ <h3>asJSON</h3>
149149
<li class="tsd-description">
150150
<aside class="tsd-sources">
151151
<ul>
152-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/c7a0a21/src/index.ts#L361">index.ts:361</a></li>
152+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L361">index.ts:361</a></li>
153153
</ul>
154154
</aside>
155155
<div class="tsd-comment tsd-typography">
@@ -202,14 +202,37 @@ <h3>read<wbr>File</h3>
202202
<li class="tsd-description">
203203
<aside class="tsd-sources">
204204
<ul>
205-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/c7a0a21/src/index.ts#L548">index.ts:548</a></li>
205+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L695">index.ts:695</a></li>
206206
</ul>
207207
</aside>
208208
<div class="tsd-comment tsd-typography">
209209
<div class="lead">
210210
<p>Read a file asynchronously from the file system.
211211
Works in Nodejs, doesn&#39;t work in the browser.</p>
212212
</div>
213+
<dl class="tsd-comment-tags">
214+
<dt>example</dt>
215+
<dd><pre>
216+
217+
const df = await dataForge.readFile("my-data-file.csv").parseCSV();
218+
</pre>
219+
</dd>
220+
<dt>example</dt>
221+
<dd><pre>
222+
223+
const options = {
224+
// ...
225+
};
226+
const df = await dataForge.readFile("my-data-file.csv").parseCSV(options);
227+
</pre>
228+
</dd>
229+
<dt>example</dt>
230+
<dd><pre>
231+
232+
const df = await dataForge.readFile("my-data-file.json").parseJSON();
233+
</pre>
234+
</dd>
235+
</dl>
213236
</div>
214237
<h4 class="tsd-parameters-title">Parameters</h4>
215238
<ul class="tsd-parameters">
@@ -235,7 +258,7 @@ <h3>read<wbr>File<wbr>Sync</h3>
235258
<li class="tsd-description">
236259
<aside class="tsd-sources">
237260
<ul>
238-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/c7a0a21/src/index.ts#L565">index.ts:565</a></li>
261+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L733">index.ts:733</a></li>
239262
</ul>
240263
</aside>
241264
<div class="tsd-comment tsd-typography">
@@ -247,6 +270,27 @@ <h3>read<wbr>File<wbr>Sync</h3>
247270
<dt>memberof</dt>
248271
<dd><p>Data-Forge</p>
249272
</dd>
273+
<dt>example</dt>
274+
<dd><pre>
275+
276+
const df = dataForge.readFileSync("my-data-file.csv").parseCSV();
277+
</pre>
278+
</dd>
279+
<dt>example</dt>
280+
<dd><pre>
281+
282+
const options = {
283+
// ...
284+
};
285+
const df = dataForge.readFileSync("my-data-file.csv").parseCSV(options);
286+
</pre>
287+
</dd>
288+
<dt>example</dt>
289+
<dd><pre>
290+
291+
const df = dataForge.readFileSync("my-data-file.json").parseJSON();
292+
</pre>
293+
</dd>
250294
</dl>
251295
</div>
252296
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/interfaces/iasyncfilereader.html‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,14 +103,31 @@ <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/c7a0a21/src/index.ts#L398">index.ts:398</a></li>
106+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L413">index.ts:413</a></li>
107107
</ul>
108108
</aside>
109109
<div class="tsd-comment tsd-typography">
110110
<div class="lead">
111111
<p>Deserialize a CSV file to a DataFrame.
112112
Returns a promise that later resolves to a DataFrame.</p>
113113
</div>
114+
<dl class="tsd-comment-tags">
115+
<dt>example</dt>
116+
<dd><pre>
117+
118+
const df = await dataForge.readFile("my-data-file.csv").parseCSV();
119+
</pre>
120+
</dd>
121+
<dt>example</dt>
122+
<dd><pre>
123+
124+
const options = {
125+
// ...
126+
};
127+
const df = await dataForge.readFile("my-data-file.csv").parseCSV(options);
128+
</pre>
129+
</dd>
130+
</dl>
114131
</div>
115132
<h4 class="tsd-parameters-title">Parameters</h4>
116133
<ul class="tsd-parameters">
@@ -133,14 +150,22 @@ <h3>parseJSON</h3>
133150
<li class="tsd-description">
134151
<aside class="tsd-sources">
135152
<ul>
136-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/c7a0a21/src/index.ts#L406">index.ts:406</a></li>
153+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L427">index.ts:427</a></li>
137154
</ul>
138155
</aside>
139156
<div class="tsd-comment tsd-typography">
140157
<div class="lead">
141158
<p>Deserialize a JSON file to a DataFrame.
142159
Returns a promise that later resolves to a DataFrame.</p>
143160
</div>
161+
<dl class="tsd-comment-tags">
162+
<dt>example</dt>
163+
<dd><pre>
164+
165+
const df = await dataForge.readFile("my-data-file.json").parseJSON();
166+
</pre>
167+
</dd>
168+
</dl>
144169
</div>
145170
<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>
146171
<p>Returns a promise of a dataframe loaded from the file.</p>

‎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/c7a0a21/src/index.ts#L25">index.ts:25</a></li>
106+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L25">index.ts:25</a></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/c7a0a21/src/index.ts#L39">index.ts:39</a></li>
147+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L39">index.ts:39</a></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/c7a0a21/src/index.ts#L125">index.ts:125</a></li>
106+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L125">index.ts:125</a></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/c7a0a21/src/index.ts#L139">index.ts:139</a></li>
147+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L139">index.ts:139</a></li>
148148
</ul>
149149
</aside>
150150
<div class="tsd-comment tsd-typography">

‎docs/interfaces/isyncfilereader.html‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,30 @@ <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/c7a0a21/src/index.ts#L462">index.ts:462</a></li>
106+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L519">index.ts:519</a></li>
107107
</ul>
108108
</aside>
109109
<div class="tsd-comment tsd-typography">
110110
<div class="lead">
111111
<p>Deserialize a CSV file to a DataFrame.</p>
112112
</div>
113+
<dl class="tsd-comment-tags">
114+
<dt>example</dt>
115+
<dd><pre>
116+
117+
const df = dataForge.readFileSync("my-data-file.csv").parseCSV();
118+
</pre>
119+
</dd>
120+
<dt>example</dt>
121+
<dd><pre>
122+
123+
const options = {
124+
// ...
125+
};
126+
const df = dataForge.readFileSync("my-data-file.csv").parseCSV(options);
127+
</pre>
128+
</dd>
129+
</dl>
113130
</div>
114131
<h4 class="tsd-parameters-title">Parameters</h4>
115132
<ul class="tsd-parameters">
@@ -132,13 +149,21 @@ <h3>parseJSON</h3>
132149
<li class="tsd-description">
133150
<aside class="tsd-sources">
134151
<ul>
135-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/c7a0a21/src/index.ts#L469">index.ts:469</a></li>
152+
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/f1cad7b/src/index.ts#L532">index.ts:532</a></li>
136153
</ul>
137154
</aside>
138155
<div class="tsd-comment tsd-typography">
139156
<div class="lead">
140157
<p>Deserialize a JSON file to a DataFrame.</p>
141158
</div>
159+
<dl class="tsd-comment-tags">
160+
<dt>example</dt>
161+
<dd><pre>
162+
163+
const df = dataForge.readFileSync("my-data-file.json").parseJSON();
164+
</pre>
165+
</dd>
166+
</dl>
142167
</div>
143168
<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>
144169
<p>Returns a dataframe that was deserialized from the file.</p>

0 commit comments

Comments
 (0)