Skip to content

Commit d027ad7

Browse files
ashleydavisashleydavis
committed
A slightly better pass at the API docs.
1 parent c7a0a21 commit d027ad7

File tree

9 files changed

+471
-27
lines changed

9 files changed

+471
-27
lines changed

‎docs/api/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/index.html‎

Lines changed: 204 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>Data-Forge</title>
6+
<title>Data-Forge FS</title>
77
<meta name="description" content="">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="assets/css/main.css">
@@ -22,7 +22,7 @@
2222
<li class="state loading">Preparing search index...</li>
2323
<li class="state failure">The search index is not available</li>
2424
</ul>
25-
<a href="index.html" class="title">Data-Forge</a>
25+
<a href="index.html" class="title">Data-Forge FS</a>
2626
</div>
2727
<div class="table-cell" id="tsd-widgets">
2828
<div id="tsd-filter">
@@ -52,7 +52,7 @@
5252
<a href="index.html">Globals</a>
5353
</li>
5454
</ul>
55-
<h1> Data-Forge</h1>
55+
<h1> Data-Forge FS</h1>
5656
</div>
5757
</div>
5858
</header>
@@ -72,9 +72,198 @@ <h3>Interfaces</h3>
7272
<li class="tsd-kind-interface"><a href="interfaces/isyncfilereader.html" class="tsd-kind-icon">ISync<wbr>File<wbr>Reader</a></li>
7373
</ul>
7474
</section>
75+
<section class="tsd-index-section ">
76+
<h3>Functions</h3>
77+
<ul class="tsd-index-list">
78+
<li class="tsd-kind-function tsd-has-type-parameter"><a href="index.html#ascsv" class="tsd-kind-icon">asCSV</a></li>
79+
<li class="tsd-kind-function tsd-has-type-parameter"><a href="index.html#asjson" class="tsd-kind-icon">asJSON</a></li>
80+
<li class="tsd-kind-function"><a href="index.html#readfile" class="tsd-kind-icon">read<wbr>File</a></li>
81+
<li class="tsd-kind-function"><a href="index.html#readfilesync" class="tsd-kind-icon">read<wbr>File<wbr>Sync</a></li>
82+
</ul>
83+
</section>
7584
</div>
7685
</section>
7786
</section>
87+
<section class="tsd-panel-group tsd-member-group ">
88+
<h2>Functions</h2>
89+
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
90+
<a name="ascsv" class="tsd-anchor"></a>
91+
<h3>asCSV</h3>
92+
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
93+
<li class="tsd-signature tsd-kind-icon">asCSV&lt;IndexT, ValueT&gt;<span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IDataFrame</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IndexT</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ValueT</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/icsvserializer.html" class="tsd-signature-type">ICsvSerializer</a></li>
94+
</ul>
95+
<ul class="tsd-descriptions">
96+
<li class="tsd-description">
97+
<aside class="tsd-sources">
98+
<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>
100+
</ul>
101+
</aside>
102+
<div class="tsd-comment tsd-typography">
103+
<div class="lead">
104+
<p>Treat the dataframe as CSV data for purposes of serialization.
105+
This is the first step you need in serializing a dataframe to a CSV data file.</p>
106+
</div>
107+
<dl class="tsd-comment-tags">
108+
<dt>example</dt>
109+
<dd><pre>
110+
111+
df.asCSV().writeFileSync("my-data-file.csv");
112+
</pre>
113+
</dd>
114+
<dt>example</dt>
115+
<dd><pre>
116+
117+
await df.asCSV().writeFile("my-data-file.csv");
118+
</pre>
119+
</dd>
120+
</dl>
121+
</div>
122+
<h4 class="tsd-type-parameters-title">Type parameters</h4>
123+
<ul class="tsd-type-parameters">
124+
<li>
125+
<h4>IndexT</h4>
126+
</li>
127+
<li>
128+
<h4>ValueT</h4>
129+
</li>
130+
</ul>
131+
<h4 class="tsd-parameters-title">Parameters</h4>
132+
<ul class="tsd-parameters">
133+
<li>
134+
<h5>this: <span class="tsd-signature-type">IDataFrame</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IndexT</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ValueT</span><span class="tsd-signature-symbol">&gt;</span></h5>
135+
</li>
136+
</ul>
137+
<h4 class="tsd-returns-title">Returns <a href="interfaces/icsvserializer.html" class="tsd-signature-type">ICsvSerializer</a></h4>
138+
<p>Returns a <a href="interfaces/icsvserializer.html">ICsvSerializer</a> that represents the dataframe for serialization in the CSV format. Call <code>writeFile</code> or <code>writeFileSync</code> to output the CSV data to a text file.</p>
139+
</li>
140+
</ul>
141+
</section>
142+
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
143+
<a name="asjson" class="tsd-anchor"></a>
144+
<h3>asJSON</h3>
145+
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
146+
<li class="tsd-signature tsd-kind-icon">asJSON&lt;IndexT, ValueT&gt;<span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IDataFrame</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IndexT</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ValueT</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/ijsonserializer.html" class="tsd-signature-type">IJsonSerializer</a></li>
147+
</ul>
148+
<ul class="tsd-descriptions">
149+
<li class="tsd-description">
150+
<aside class="tsd-sources">
151+
<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>
153+
</ul>
154+
</aside>
155+
<div class="tsd-comment tsd-typography">
156+
<div class="lead">
157+
<p>Treat the dataframe as JSON data for purposes of serialization.
158+
This is the first step you need in serializing a dataframe to a JSON data file.</p>
159+
</div>
160+
<dl class="tsd-comment-tags">
161+
<dt>example</dt>
162+
<dd><pre>
163+
164+
df.asJSON().writeFileSync("my-data-file.json");
165+
</pre>
166+
</dd>
167+
<dt>example</dt>
168+
<dd><pre>
169+
170+
await df.asJSON().writeFile("my-data-file.json");
171+
</pre>
172+
</dd>
173+
</dl>
174+
</div>
175+
<h4 class="tsd-type-parameters-title">Type parameters</h4>
176+
<ul class="tsd-type-parameters">
177+
<li>
178+
<h4>IndexT</h4>
179+
</li>
180+
<li>
181+
<h4>ValueT</h4>
182+
</li>
183+
</ul>
184+
<h4 class="tsd-parameters-title">Parameters</h4>
185+
<ul class="tsd-parameters">
186+
<li>
187+
<h5>this: <span class="tsd-signature-type">IDataFrame</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IndexT</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ValueT</span><span class="tsd-signature-symbol">&gt;</span></h5>
188+
</li>
189+
</ul>
190+
<h4 class="tsd-returns-title">Returns <a href="interfaces/ijsonserializer.html" class="tsd-signature-type">IJsonSerializer</a></h4>
191+
<p>Returns a <a href="interfaces/ijsonserializer.html">IJsonSerializer</a> that represents the dataframe for serialization in the JSON format. Call <code>writeFile</code> or <code>writeFileSync</code> to output the JSON data to a text file.</p>
192+
</li>
193+
</ul>
194+
</section>
195+
<section class="tsd-panel tsd-member tsd-kind-function">
196+
<a name="readfile" class="tsd-anchor"></a>
197+
<h3>read<wbr>File</h3>
198+
<ul class="tsd-signatures tsd-kind-function">
199+
<li class="tsd-signature tsd-kind-icon">read<wbr>File<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/iasyncfilereader.html" class="tsd-signature-type">IAsyncFileReader</a></li>
200+
</ul>
201+
<ul class="tsd-descriptions">
202+
<li class="tsd-description">
203+
<aside class="tsd-sources">
204+
<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>
206+
</ul>
207+
</aside>
208+
<div class="tsd-comment tsd-typography">
209+
<div class="lead">
210+
<p>Read a file asynchronously from the file system.
211+
Works in Nodejs, doesn&#39;t work in the browser.</p>
212+
</div>
213+
</div>
214+
<h4 class="tsd-parameters-title">Parameters</h4>
215+
<ul class="tsd-parameters">
216+
<li>
217+
<h5>filePath: <span class="tsd-signature-type">string</span></h5>
218+
<div class="tsd-comment tsd-typography">
219+
<p>The path to the file to read.</p>
220+
</div>
221+
</li>
222+
</ul>
223+
<h4 class="tsd-returns-title">Returns <a href="interfaces/iasyncfilereader.html" class="tsd-signature-type">IAsyncFileReader</a></h4>
224+
<p>Returns an object that represents the file. Use <code>parseCSV</code> or <code>parseJSON</code> to deserialize to a DataFrame.</p>
225+
</li>
226+
</ul>
227+
</section>
228+
<section class="tsd-panel tsd-member tsd-kind-function">
229+
<a name="readfilesync" class="tsd-anchor"></a>
230+
<h3>read<wbr>File<wbr>Sync</h3>
231+
<ul class="tsd-signatures tsd-kind-function">
232+
<li class="tsd-signature tsd-kind-icon">read<wbr>File<wbr>Sync<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/isyncfilereader.html" class="tsd-signature-type">ISyncFileReader</a></li>
233+
</ul>
234+
<ul class="tsd-descriptions">
235+
<li class="tsd-description">
236+
<aside class="tsd-sources">
237+
<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>
239+
</ul>
240+
</aside>
241+
<div class="tsd-comment tsd-typography">
242+
<div class="lead">
243+
<p>Read a file synchronously from the file system.
244+
Works in Nodejs, doesn&#39;t work in the browser.</p>
245+
</div>
246+
<dl class="tsd-comment-tags">
247+
<dt>memberof</dt>
248+
<dd><p>Data-Forge</p>
249+
</dd>
250+
</dl>
251+
</div>
252+
<h4 class="tsd-parameters-title">Parameters</h4>
253+
<ul class="tsd-parameters">
254+
<li>
255+
<h5>filePath: <span class="tsd-signature-type">string</span></h5>
256+
<div class="tsd-comment tsd-typography">
257+
<p>The path to the file to read.</p>
258+
</div>
259+
</li>
260+
</ul>
261+
<h4 class="tsd-returns-title">Returns <a href="interfaces/isyncfilereader.html" class="tsd-signature-type">ISyncFileReader</a></h4>
262+
<p>Returns an object that represents the file. Use <code>parseCSV</code> or <code>parseJSON</code> to deserialize to a DataFrame.</p>
263+
</li>
264+
</ul>
265+
</section>
266+
</section>
78267
</div>
79268
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
80269
<nav class="tsd-navigation primary">
@@ -98,6 +287,18 @@ <h3>Interfaces</h3>
98287
<li class=" tsd-kind-interface">
99288
<a href="interfaces/isyncfilereader.html" class="tsd-kind-icon">ISync<wbr>File<wbr>Reader</a>
100289
</li>
290+
<li class=" tsd-kind-function tsd-has-type-parameter">
291+
<a href="index.html#ascsv" class="tsd-kind-icon">asCSV</a>
292+
</li>
293+
<li class=" tsd-kind-function tsd-has-type-parameter">
294+
<a href="index.html#asjson" class="tsd-kind-icon">asJSON</a>
295+
</li>
296+
<li class=" tsd-kind-function">
297+
<a href="index.html#readfile" class="tsd-kind-icon">read<wbr>File</a>
298+
</li>
299+
<li class=" tsd-kind-function">
300+
<a href="index.html#readfilesync" class="tsd-kind-icon">read<wbr>File<wbr>Sync</a>
301+
</li>
101302
</ul>
102303
</nav>
103304
</div>

‎docs/api/interfaces/iasyncfilereader.html‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>IAsyncFileReader | Data-Forge</title>
6+
<title>IAsyncFileReader | Data-Forge FS</title>
77
<meta name="description" content="">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
@@ -22,7 +22,7 @@
2222
<li class="state loading">Preparing search index...</li>
2323
<li class="state failure">The search index is not available</li>
2424
</ul>
25-
<a href="../index.html" class="title">Data-Forge</a>
25+
<a href="../index.html" class="title">Data-Forge FS</a>
2626
</div>
2727
<div class="table-cell" id="tsd-widgets">
2828
<div id="tsd-filter">
@@ -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/353979a/src/index.ts#L338">index.ts:338</a></li>
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>
107107
</ul>
108108
</aside>
109109
<div class="tsd-comment tsd-typography">
@@ -133,7 +133,7 @@ <h3>parseJSON</h3>
133133
<li class="tsd-description">
134134
<aside class="tsd-sources">
135135
<ul>
136-
<li>Defined in <a href="https://github.com/data-forge/data-forge-fs/blob/353979a/src/index.ts#L346">index.ts:346</a></li>
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>
137137
</ul>
138138
</aside>
139139
<div class="tsd-comment tsd-typography">
@@ -183,6 +183,18 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
183183
<li class=" tsd-kind-interface">
184184
<a href="isyncfilereader.html" class="tsd-kind-icon">ISync<wbr>File<wbr>Reader</a>
185185
</li>
186+
<li class=" tsd-kind-function tsd-has-type-parameter">
187+
<a href="../index.html#ascsv" class="tsd-kind-icon">asCSV</a>
188+
</li>
189+
<li class=" tsd-kind-function tsd-has-type-parameter">
190+
<a href="../index.html#asjson" class="tsd-kind-icon">asJSON</a>
191+
</li>
192+
<li class=" tsd-kind-function">
193+
<a href="../index.html#readfile" class="tsd-kind-icon">read<wbr>File</a>
194+
</li>
195+
<li class=" tsd-kind-function">
196+
<a href="../index.html#readfilesync" class="tsd-kind-icon">read<wbr>File<wbr>Sync</a>
197+
</li>
186198
</ul>
187199
</nav>
188200
</div>

0 commit comments

Comments
 (0)