Skip to content

Commit

Permalink
chore: generate client docs nft.storage-v3.2.0 #345
Browse files Browse the repository at this point in the history
  • Loading branch information
@hugomrdias
hugomrdias committed Aug 27, 2021
1 parent 88b1ff6 commit b738dff
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
42 changes: 21 additions & 21 deletions docs/client/classes/NFTStorage.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/59f730c/packages/client/src/lib.js#L57">packages/client/src/lib.js:57</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L56">packages/client/src/lib.js:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -187,7 +187,7 @@ <h3>endpoint</h3>
<div class="tsd-signature tsd-kind-icon">endpoint<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">URL</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/59f730c/packages/client/src/lib.js#L68">packages/client/src/lib.js:68</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L67">packages/client/src/lib.js:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -206,7 +206,7 @@ <h3>token</h3>
<div class="tsd-signature tsd-kind-icon">token<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/59f730c/packages/client/src/lib.js#L63">packages/client/src/lib.js:63</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L62">packages/client/src/lib.js:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -232,7 +232,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/59f730c/packages/client/src/lib.js#L391">packages/client/src/lib.js:391</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L390">packages/client/src/lib.js:390</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -242,7 +242,7 @@ <h3>check</h3>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">status</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">check</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;Qmf412jQZiuVUtdgnB36FXFX7xg5V6KEbSJ4dpQuhkLyfD&#039;</span><span style="color: #000000">)</span>
<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">status</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">check</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;zdj7Wn9FQAURCP6MbwcWuzi7u65kAsXCdjNTkhbJcoaXBusq9&#039;</span><span style="color: #000000">)</span>
</code></pre>
</dd>
</dl>
Expand All @@ -269,7 +269,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/59f730c/packages/client/src/lib.js#L377">packages/client/src/lib.js:377</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L376">packages/client/src/lib.js:376</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -282,7 +282,7 @@ <h3>delete</h3>
</blockquote>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-js"><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">delete</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;Qmf412jQZiuVUtdgnB36FXFX7xg5V6KEbSJ4dpQuhkLyfD&#039;</span><span style="color: #000000">)</span>
<dd><pre><code class="language-js"><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">delete</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;zdj7Wn9FQAURCP6MbwcWuzi7u65kAsXCdjNTkhbJcoaXBusq9&#039;</span><span style="color: #000000">)</span>
</code></pre>
</dd>
</dl>
Expand All @@ -309,7 +309,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/59f730c/packages/client/src/lib.js#L361">packages/client/src/lib.js:361</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L360">packages/client/src/lib.js:360</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -319,7 +319,7 @@ <h3>status</h3>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">status</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">status</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;Qmf412jQZiuVUtdgnB36FXFX7xg5V6KEbSJ4dpQuhkLyfD&#039;</span><span style="color: #000000">)</span>
<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">status</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">status</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;zdj7Wn9FQAURCP6MbwcWuzi7u65kAsXCdjNTkhbJcoaXBusq9&#039;</span><span style="color: #000000">)</span>
</code></pre>
</dd>
</dl>
Expand All @@ -346,7 +346,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/59f730c/packages/client/src/lib.js#L434">packages/client/src/lib.js:434</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L433">packages/client/src/lib.js:433</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -412,7 +412,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/59f730c/packages/client/src/lib.js#L287">packages/client/src/lib.js:287</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L286">packages/client/src/lib.js:286</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -426,7 +426,7 @@ <h3>store<wbr>Blob</h3>
<dt>example</dt>
<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">content</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Blob</span><span style="color: #000000">([</span><span style="color: #A31515">&#039;hello world&#039;</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">storeBlob</span><span style="color: #000000">(</span><span style="color: #001080">content</span><span style="color: #000000">)</span>
<span style="color: #001080">cid</span><span style="color: #000000"> </span><span style="color: #008000">//&gt; &#039;Qmf412jQZiuVUtdgnB36FXFX7xg5V6KEbSJ4dpQuhkLyfD&#039;</span>
<span style="color: #001080">cid</span><span style="color: #000000"> </span><span style="color: #008000">//&gt; &#039;zdj7Wn9FQAURCP6MbwcWuzi7u65kAsXCdjNTkhbJcoaXBusq9&#039;</span>
</code></pre>
</dd>
</dl>
Expand All @@ -453,7 +453,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/59f730c/packages/client/src/lib.js#L327">packages/client/src/lib.js:327</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L326">packages/client/src/lib.js:326</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -513,7 +513,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/59f730c/packages/client/src/lib.js#L347">packages/client/src/lib.js:347</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L346">packages/client/src/lib.js:346</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -555,7 +555,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/59f730c/packages/client/src/lib.js#L237">packages/client/src/lib.js:237</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L236">packages/client/src/lib.js:236</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -581,7 +581,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/59f730c/packages/client/src/lib.js#L258">packages/client/src/lib.js:258</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L257">packages/client/src/lib.js:257</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -607,7 +607,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/59f730c/packages/client/src/lib.js#L211">packages/client/src/lib.js:211</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L210">packages/client/src/lib.js:210</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -633,7 +633,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/59f730c/packages/client/src/lib.js#L183">packages/client/src/lib.js:183</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L182">packages/client/src/lib.js:182</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -665,7 +665,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/59f730c/packages/client/src/lib.js#L84">packages/client/src/lib.js:84</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L83">packages/client/src/lib.js:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -691,7 +691,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/59f730c/packages/client/src/lib.js#L110">packages/client/src/lib.js:110</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L109">packages/client/src/lib.js:109</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -720,7 +720,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/59f730c/packages/client/src/lib.js#L148">packages/client/src/lib.js:148</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L147">packages/client/src/lib.js:147</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
10 changes: 5 additions & 5 deletions docs/client/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> Blob</h3>
<div class="tsd-signature tsd-kind-icon">Blob<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>prototype<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol"> }</span><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/59f730c/packages/client/src/platform.ts#L6">packages/client/src/platform.ts:6</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/platform.ts#L6">packages/client/src/platform.ts:6</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -130,7 +130,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> File</h3>
<div class="tsd-signature tsd-kind-icon">File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>prototype<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">File</span><span class="tsd-signature-symbol"> }</span><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/59f730c/packages/client/src/platform.ts#L7">packages/client/src/platform.ts:7</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/platform.ts#L7">packages/client/src/platform.ts:7</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> Form<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">Form<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>prototype<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol"> }</span><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/59f730c/packages/client/src/platform.ts#L2">packages/client/src/platform.ts:2</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/platform.ts#L2">packages/client/src/platform.ts:2</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -166,7 +166,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> Token</h3>
<div class="tsd-signature tsd-kind-icon">Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">Token</span><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/59f730c/packages/client/src/lib.js#L490">packages/client/src/lib.js:490</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/lib.js#L494">packages/client/src/lib.js:494</a></li>
</ul>
</aside>
</section>
Expand All @@ -183,7 +183,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> to<wbr>GatewayURL</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/59f730c/packages/client/src/gateway.js#L17">packages/client/src/gateway.js:17</a></li>
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/88b1ff6/packages/client/src/gateway.js#L17">packages/client/src/gateway.js:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down

0 comments on commit b738dff

Please sign in to comment.