Skip to content
This repository was archived by the owner on Mar 12, 2020. It is now read-only.

Commit a43ca0b

Browse files
carsonfarmercarsonfarmer
committed
update: docs and readme
Signed-off-by: Carson Farmer <[email protected]>
1 parent 2f54892 commit a43ca0b

File tree

4 files changed

+15
-50
lines changed

4 files changed

+15
-50
lines changed

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,11 @@ Textile's JS HTTP Client is a work in progress. As such, there's a few things yo
101101
<!-- ⛔️ AUTO-GENERATED-CONTENT:START (CONTRIBUTORS) -->
102102
| **Commits** | **Contributor** |
103103
| --- | --- |
104-
| 101 | [carsonfarmer](https://github.com/carsonfarmer) |
104+
| 109 | [carsonfarmer](https://github.com/carsonfarmer) |
105105
| 25 | [andrewxhill](https://github.com/andrewxhill) |
106106
| 2 | [robbynshaw](https://github.com/robbynshaw) |
107+
| 1 | [balupton](https://github.com/balupton) |
108+
| 1 | [connectdotz](https://github.com/connectdotz) |
107109
| 1 | [flyskywhy](https://github.com/flyskywhy) |
108110

109111
<!-- ⛔️ AUTO-GENERATED-CONTENT:END -->

‎docs/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/classes/blocks.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ <h3>constructor</h3>
147147
<aside class="tsd-sources">
148148
<p>Overrides API.__constructor</p>
149149
<ul>
150-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L28">modules/blocks.ts:28</a></li>
150+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L30">modules/blocks.ts:30</a></li>
151151
</ul>
152152
</aside>
153153
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -169,7 +169,7 @@ <h3>threads</h3>
169169
<div class="tsd-signature tsd-kind-icon">threads<span class="tsd-signature-symbol">:</span> <a href="threads.html" class="tsd-signature-type">Threads</a></div>
170170
<aside class="tsd-sources">
171171
<ul>
172-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L28">modules/blocks.ts:28</a></li>
172+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L30">modules/blocks.ts:30</a></li>
173173
</ul>
174174
</aside>
175175
</section>
@@ -186,7 +186,7 @@ <h3>file<wbr>Content</h3>
186186
<li class="tsd-description">
187187
<aside class="tsd-sources">
188188
<ul>
189-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L81">modules/blocks.ts:81</a></li>
189+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L83">modules/blocks.ts:83</a></li>
190190
</ul>
191191
</aside>
192192
<div class="tsd-comment tsd-typography">
@@ -230,7 +230,7 @@ <h3>file<wbr>Meta</h3>
230230
<li class="tsd-description">
231231
<aside class="tsd-sources">
232232
<ul>
233-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L94">modules/blocks.ts:94</a></li>
233+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L96">modules/blocks.ts:96</a></li>
234234
</ul>
235235
</aside>
236236
<div class="tsd-comment tsd-typography">
@@ -274,7 +274,7 @@ <h3>ignore</h3>
274274
<li class="tsd-description">
275275
<aside class="tsd-sources">
276276
<ul>
277-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L68">modules/blocks.ts:68</a></li>
277+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L70">modules/blocks.ts:70</a></li>
278278
</ul>
279279
</aside>
280280
<div class="tsd-comment tsd-typography">
@@ -306,7 +306,7 @@ <h3>list</h3>
306306
<li class="tsd-description">
307307
<aside class="tsd-sources">
308308
<ul>
309-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L53">modules/blocks.ts:53</a></li>
309+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L55">modules/blocks.ts:55</a></li>
310310
</ul>
311311
</aside>
312312
<div class="tsd-comment tsd-typography">
@@ -350,7 +350,7 @@ <h3>meta</h3>
350350
<li class="tsd-description">
351351
<aside class="tsd-sources">
352352
<ul>
353-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L40">modules/blocks.ts:40</a></li>
353+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/blocks.ts#L42">modules/blocks.ts:42</a></li>
354354
</ul>
355355
</aside>
356356
<div class="tsd-comment tsd-typography">

‎docs/classes/files.html‎

Lines changed: 4 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,6 @@ <h3>Properties</h3>
118118
<h3>Methods</h3>
119119
<ul class="tsd-index-list">
120120
<li class="tsd-kind-method tsd-parent-kind-class"><a href="files.html#add" class="tsd-kind-icon">add</a></li>
121-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="files.html#get" class="tsd-kind-icon">get</a></li>
122121
<li class="tsd-kind-method tsd-parent-kind-class"><a href="files.html#ignore" class="tsd-kind-icon">ignore</a></li>
123122
<li class="tsd-kind-method tsd-parent-kind-class"><a href="files.html#keys" class="tsd-kind-icon">keys</a></li>
124123
<li class="tsd-kind-method tsd-parent-kind-class"><a href="files.html#list" class="tsd-kind-icon">list</a></li>
@@ -270,7 +269,7 @@ <h3>add</h3>
270269
<li class="tsd-description">
271270
<aside class="tsd-sources">
272271
<ul>
273-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/files.ts#L87">modules/files.ts:87</a></li>
272+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/files.ts#L74">modules/files.ts:74</a></li>
274273
</ul>
275274
</aside>
276275
<div class="tsd-comment tsd-typography">
@@ -304,39 +303,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
304303
</li>
305304
</ul>
306305
</section>
307-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
308-
<a name="get" class="tsd-anchor"></a>
309-
<h3>get</h3>
310-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
311-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>id<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="files.html" class="tsd-signature-type">Files</a><span class="tsd-signature-symbol">&gt;</span></li>
312-
</ul>
313-
<ul class="tsd-descriptions">
314-
<li class="tsd-description">
315-
<aside class="tsd-sources">
316-
<ul>
317-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/files.ts#L29">modules/files.ts:29</a></li>
318-
</ul>
319-
</aside>
320-
<div class="tsd-comment tsd-typography">
321-
<div class="lead">
322-
<p>Retrieves a thread file by block ID</p>
323-
</div>
324-
<p>Alias for <code>file.meta()</code></p>
325-
</div>
326-
<h4 class="tsd-parameters-title">Parameters</h4>
327-
<ul class="tsd-parameters">
328-
<li>
329-
<h5>id: <span class="tsd-signature-type">string</span></h5>
330-
<div class="tsd-comment tsd-typography">
331-
<p>ID of the target file</p>
332-
</div>
333-
</li>
334-
</ul>
335-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="files.html" class="tsd-signature-type">Files</a><span class="tsd-signature-symbol">&gt;</span></h4>
336-
<p>The thread object</p>
337-
</li>
338-
</ul>
339-
</section>
340306
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
341307
<a name="ignore" class="tsd-anchor"></a>
342308
<h3>ignore</h3>
@@ -347,7 +313,7 @@ <h3>ignore</h3>
347313
<li class="tsd-description">
348314
<aside class="tsd-sources">
349315
<ul>
350-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/files.ts#L74">modules/files.ts:74</a></li>
316+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/files.ts#L61">modules/files.ts:61</a></li>
351317
</ul>
352318
</aside>
353319
<div class="tsd-comment tsd-typography">
@@ -381,7 +347,7 @@ <h3>keys</h3>
381347
<li class="tsd-description">
382348
<aside class="tsd-sources">
383349
<ul>
384-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/files.ts#L60">modules/files.ts:60</a></li>
350+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/files.ts#L47">modules/files.ts:47</a></li>
385351
</ul>
386352
</aside>
387353
<div class="tsd-comment tsd-typography">
@@ -415,7 +381,7 @@ <h3>list</h3>
415381
<li class="tsd-description">
416382
<aside class="tsd-sources">
417383
<ul>
418-
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/files.ts#L42">modules/files.ts:42</a></li>
384+
<li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/modules/files.ts#L29">modules/files.ts:29</a></li>
419385
</ul>
420386
</aside>
421387
<div class="tsd-comment tsd-typography">
@@ -502,9 +468,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
502468
<li class=" tsd-kind-method tsd-parent-kind-class">
503469
<a href="files.html#add" class="tsd-kind-icon">add</a>
504470
</li>
505-
<li class=" tsd-kind-method tsd-parent-kind-class">
506-
<a href="files.html#get" class="tsd-kind-icon">get</a>
507-
</li>
508471
<li class=" tsd-kind-method tsd-parent-kind-class">
509472
<a href="files.html#ignore" class="tsd-kind-icon">ignore</a>
510473
</li>

0 commit comments

Comments
 (0)