Skip to content

Commit

Permalink
chore: generate client docs nft.storage-v2.1.1 #196
Browse files Browse the repository at this point in the history
  • Loading branch information
@alanshaw
alanshaw committed Jun 18, 2021
1 parent e49b684 commit c7a2f5b
Show file tree
Hide file tree
Showing 23 changed files with 127 additions and 125 deletions.
34 changes: 18 additions & 16 deletions docs/client/classes/lib.nftstorage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L24">packages/client/src/lib.js:24</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L24">packages/client/src/lib.js:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -211,7 +211,7 @@ <h3>check</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L338">packages/client/src/lib.js:338</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L341">packages/client/src/lib.js:341</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -248,7 +248,7 @@ <h3>delete</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L324">packages/client/src/lib.js:324</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L327">packages/client/src/lib.js:327</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -288,7 +288,7 @@ <h3>status</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L308">packages/client/src/lib.js:308</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L311">packages/client/src/lib.js:311</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -325,7 +325,7 @@ <h3>store</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L381">packages/client/src/lib.js:381</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L384">packages/client/src/lib.js:384</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -391,7 +391,7 @@ <h3>store<wbr>Blob</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L251">packages/client/src/lib.js:251</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L251">packages/client/src/lib.js:251</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -432,7 +432,7 @@ <h3>store<wbr>Car</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L274">packages/client/src/lib.js:274</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L277">packages/client/src/lib.js:277</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -443,11 +443,13 @@ <h3>store<wbr>Car</h3>
<p>Takes a <a href="https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob">Blob</a>
or a <a href="https://developer.mozilla.org/en-US/docs/Web/API/File">File</a>.</p>
<p>Returns the corresponding Content Identifier (CID).</p>
<p>See the <a href="https://www.npmjs.com/package/ipfs-car"><code>ipfs-car</code> docs</a> for more
details on packing a CAR file.</p>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-js"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">packToBlob</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;ipfs-car&#039;</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">data</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;Hello world&#039;</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> {</span><span style="color: #0070C1">root</span><span style="color: #000000">, </span><span style="color: #0070C1">car</span><span style="color: #000000">} = </span><span style="color: #795E26">packToBlob</span><span style="color: #000000">({ </span><span style="color: #001080">input:</span><span style="color: #000000"> [</span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">TextEncoder</span><span style="color: #000000">().</span><span style="color: #795E26">encode</span><span style="color: #000000">(</span><span style="color: #001080">data</span><span style="color: #000000">)] })</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">root</span><span style="color: #000000">, </span><span style="color: #0070C1">car</span><span style="color: #000000"> } = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #795E26">packToBlob</span><span style="color: #000000">({ </span><span style="color: #001080">input:</span><span style="color: #000000"> [</span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">TextEncoder</span><span style="color: #000000">().</span><span style="color: #795E26">encode</span><span style="color: #000000">(</span><span style="color: #001080">data</span><span style="color: #000000">)] })</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">expectedCid</span><span style="color: #000000"> = </span><span style="color: #001080">root</span><span style="color: #000000">.</span><span style="color: #795E26">toString</span><span style="color: #000000">()</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">cid</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">storeCar</span><span style="color: #000000">(</span><span style="color: #001080">car</span><span style="color: #000000">)</span>
<span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">assert</span><span style="color: #000000">(</span><span style="color: #001080">cid</span><span style="color: #000000"> === </span><span style="color: #001080">expectedCid</span><span style="color: #000000">)</span>
Expand Down Expand Up @@ -477,7 +479,7 @@ <h3>store<wbr>Directory</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L294">packages/client/src/lib.js:294</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L297">packages/client/src/lib.js:297</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -519,7 +521,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> check</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L201">packages/client/src/lib.js:201</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L201">packages/client/src/lib.js:201</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -545,7 +547,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> delete</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L222">packages/client/src/lib.js:222</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L222">packages/client/src/lib.js:222</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -571,7 +573,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> status</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L175">packages/client/src/lib.js:175</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L175">packages/client/src/lib.js:175</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -597,7 +599,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> store</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L147">packages/client/src/lib.js:147</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L147">packages/client/src/lib.js:147</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -629,7 +631,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> store<wbr>Blob</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L75">packages/client/src/lib.js:75</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L75">packages/client/src/lib.js:75</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -655,7 +657,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> store<wbr>Car</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L100">packages/client/src/lib.js:100</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L100">packages/client/src/lib.js:100</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -681,7 +683,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> store<wbr>Directory</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib.js#L112">packages/client/src/lib.js:112</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib.js#L112">packages/client/src/lib.js:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/client/classes/token.token-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/token.js#L11">packages/client/src/token.js:11</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/token.js#L11">packages/client/src/token.js:11</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -197,7 +197,7 @@ <h3>embed</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/token.js#L34">packages/client/src/token.js:34</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/token.js#L34">packages/client/src/token.js:34</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../modules/lib_interface.html#matchrecord" class="tsd-signature-type" data-tsd-kind="Type alias">MatchRecord</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">URL</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -214,7 +214,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> embed</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/token.js#L43">packages/client/src/token.js:43</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/token.js#L43">packages/client/src/token.js:43</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down
12 changes: 6 additions & 6 deletions docs/client/interfaces/lib_interface.api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h3>check</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib/interface.ts#L69">packages/client/src/lib/interface.ts:69</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib/interface.ts#L69">packages/client/src/lib/interface.ts:69</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -137,7 +137,7 @@ <h3>delete</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib/interface.ts#L65">packages/client/src/lib/interface.ts:65</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib/interface.ts#L65">packages/client/src/lib/interface.ts:65</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -170,7 +170,7 @@ <h3>status</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib/interface.ts#L59">packages/client/src/lib/interface.ts:59</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib/interface.ts#L59">packages/client/src/lib/interface.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -202,7 +202,7 @@ <h3>store</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib/interface.ts#L43">packages/client/src/lib/interface.ts:43</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib/interface.ts#L43">packages/client/src/lib/interface.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -252,7 +252,7 @@ <h3>store<wbr>Blob</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib/interface.ts#L48">packages/client/src/lib/interface.ts:48</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib/interface.ts#L48">packages/client/src/lib/interface.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -283,7 +283,7 @@ <h3>store<wbr>Directory</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib/interface.ts#L54">packages/client/src/lib/interface.ts:54</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib/interface.ts#L54">packages/client/src/lib/interface.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/client/interfaces/lib_interface.checkresult.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3>cid</h3>
<div class="tsd-signature tsd-kind-icon">cid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib/interface.ts#L73">packages/client/src/lib/interface.ts:73</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib/interface.ts#L73">packages/client/src/lib/interface.ts:73</a></li>
</ul>
</aside>
</section>
Expand All @@ -109,7 +109,7 @@ <h3>deals</h3>
<div class="tsd-signature tsd-kind-icon">deals<span class="tsd-signature-symbol">:</span> <a href="../modules/lib_interface.html#deal" class="tsd-signature-type" data-tsd-kind="Type alias">Deal</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib/interface.ts#L75">packages/client/src/lib/interface.ts:75</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib/interface.ts#L75">packages/client/src/lib/interface.ts:75</a></li>
</ul>
</aside>
</section>
Expand All @@ -119,7 +119,7 @@ <h3>pin</h3>
<div class="tsd-signature tsd-kind-icon">pin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="../modules/lib_interface.html#pinstatus" class="tsd-signature-type" data-tsd-kind="Type alias">PinStatus</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/cbd27df/packages/client/src/lib/interface.ts#L74">packages/client/src/lib/interface.ts:74</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/e49b684/packages/client/src/lib/interface.ts#L74">packages/client/src/lib/interface.ts:74</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand Down
Loading

0 comments on commit c7a2f5b

Please sign in to comment.