Skip to content

Commit 916704d

Browse files
hugomrdiashugomrdias
committed
Merge branch 'main' of github.com:ipfs-shipyard/nft.storage
* 'main' of github.com:ipfs-shipyard/nft.storage: chore: generate client docs nft.storage-v3.1.2 #302 chore: release nft.storage 3.1.2 (#302)
2 parents d8152da + 969a60c commit 916704d

28 files changed

Lines changed: 8945 additions & 293 deletions

‎docs/client/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/client/classes/NFTStorage.html renamed to docs/client/classes/lib.NFTStorage.html

Lines changed: 141 additions & 107 deletions
Large diffs are not rendered by default.

‎docs/client/classes/lib_interface.CID.html‎

Lines changed: 1045 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/client/classes/token.Token.html‎

Lines changed: 377 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/client/index.html‎

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -105,32 +105,32 @@ <h3>Usage</h3>
105105
<nav class="tsd-navigation primary">
106106
<ul>
107107
<li class=" ">
108-
<a href="modules.html">Exports</a>
108+
<a href="modules.html">Modules</a>
109109
</li>
110-
</ul>
111-
</nav>
112-
<nav class="tsd-navigation secondary menu-sticky">
113-
<ul class="before-current">
114-
<li class=" tsd-kind-class">
115-
<a href="classes/NFTStorage.html" class="tsd-kind-icon">NFTStorage</a>
110+
<li class=" tsd-kind-module">
111+
<a href="modules/gateway.html">gateway</a>
116112
</li>
117-
<li class=" tsd-kind-variable">
118-
<a href="modules.html#Blob" class="tsd-kind-icon">Blob</a>
113+
<li class=" tsd-kind-module">
114+
<a href="modules/lib.html">lib</a>
119115
</li>
120-
<li class=" tsd-kind-variable">
121-
<a href="modules.html#File" class="tsd-kind-icon">File</a>
116+
<li class=" tsd-kind-module">
117+
<a href="modules/lib_interface.html">lib/interface</a>
122118
</li>
123-
<li class=" tsd-kind-variable">
124-
<a href="modules.html#FormData" class="tsd-kind-icon">Form<wbr>Data</a>
119+
<li class=" tsd-kind-module">
120+
<a href="modules/platform.html">platform</a>
125121
</li>
126-
<li class=" tsd-kind-variable">
127-
<a href="modules.html#Token" class="tsd-kind-icon">Token</a>
122+
<li class=" tsd-kind-module">
123+
<a href="modules/platform_web.html">platform.web</a>
128124
</li>
129-
<li class=" tsd-kind-function">
130-
<a href="modules.html#toGatewayURL" class="tsd-kind-icon">to<wbr>GatewayURL</a>
125+
<li class=" tsd-kind-module">
126+
<a href="modules/token.html">token</a>
131127
</li>
132128
</ul>
133129
</nav>
130+
<nav class="tsd-navigation secondary menu-sticky">
131+
<ul class="before-current">
132+
</ul>
133+
</nav>
134134
</div>
135135
</div>
136136
</div>
@@ -139,12 +139,19 @@ <h3>Usage</h3>
139139
<h2>Legend</h2>
140140
<div class="tsd-legend-group">
141141
<ul class="tsd-legend">
142-
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
143-
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
144-
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
142+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
143+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
144+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
145+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
146+
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
147+
</ul>
148+
<ul class="tsd-legend">
149+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
150+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
145151
</ul>
146152
<ul class="tsd-legend">
147-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
153+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
154+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
148155
</ul>
149156
</div>
150157
</div>

‎docs/client/interfaces/lib_interface.API.html‎

Lines changed: 540 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/client/interfaces/lib_interface.CheckResult.html‎

Lines changed: 294 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,294 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>CheckResult | nft.storage</title>
7+
<meta name="description" content="Documentation for nft.storage">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="../assets/css/main.css">
10+
<script async src="../assets/js/search.js" id="search-script"></script>
11+
</head>
12+
<body>
13+
<header>
14+
<div class="tsd-page-toolbar">
15+
<div class="container">
16+
<div class="table-wrap">
17+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18+
<div class="field">
19+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20+
<input id="tsd-search-field" type="text" />
21+
</div>
22+
<ul class="results">
23+
<li class="state loading">Preparing search index...</li>
24+
<li class="state failure">The search index is not available</li>
25+
</ul>
26+
<a href="../index.html" class="title">nft.storage</a>
27+
</div>
28+
<div class="table-cell" id="tsd-widgets">
29+
<div id="tsd-filter">
30+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31+
<div class="tsd-filter-group">
32+
<div class="tsd-select" id="tsd-filter-visibility">
33+
<span class="tsd-select-label">All</span>
34+
<ul class="tsd-select-list">
35+
<li data-value="public">Public</li>
36+
<li data-value="protected">Public/Protected</li>
37+
<li data-value="private" class="selected">All</li>
38+
</ul>
39+
</div>
40+
<input type="checkbox" id="tsd-filter-inherited" checked />
41+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42+
<input type="checkbox" id="tsd-filter-externals" checked />
43+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44+
</div>
45+
</div>
46+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47+
</div>
48+
</div>
49+
</div>
50+
</div>
51+
<div class="tsd-page-title">
52+
<div class="container">
53+
<ul class="tsd-breadcrumb">
54+
<li>
55+
<a href="../modules.html">nft.storage</a>
56+
</li>
57+
<li>
58+
<a href="../modules/lib_interface.html">lib/interface</a>
59+
</li>
60+
<li>
61+
<a href="lib_interface.CheckResult.html">CheckResult</a>
62+
</li>
63+
</ul>
64+
<h1>Interface CheckResult</h1>
65+
</div>
66+
</div>
67+
</header>
68+
<div class="container container-main">
69+
<div class="row">
70+
<div class="col-8 col-content">
71+
<section class="tsd-panel tsd-hierarchy">
72+
<h3>Hierarchy</h3>
73+
<ul class="tsd-hierarchy">
74+
<li>
75+
<span class="target">CheckResult</span>
76+
</li>
77+
</ul>
78+
</section>
79+
<section class="tsd-panel-group tsd-index-group">
80+
<h2>Index</h2>
81+
<section class="tsd-panel tsd-index-panel">
82+
<div class="tsd-index-content">
83+
<section class="tsd-index-section ">
84+
<h3>Properties</h3>
85+
<ul class="tsd-index-list">
86+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="lib_interface.CheckResult.html#cid" class="tsd-kind-icon">cid</a></li>
87+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="lib_interface.CheckResult.html#deals" class="tsd-kind-icon">deals</a></li>
88+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="lib_interface.CheckResult.html#pin" class="tsd-kind-icon">pin</a></li>
89+
</ul>
90+
</section>
91+
</div>
92+
</section>
93+
</section>
94+
<section class="tsd-panel-group tsd-member-group ">
95+
<h2>Properties</h2>
96+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
97+
<a name="cid" class="tsd-anchor"></a>
98+
<h3>cid</h3>
99+
<div class="tsd-signature tsd-kind-icon">cid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100+
<aside class="tsd-sources">
101+
<ul>
102+
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/1dd1bd4/packages/client/src/lib/interface.ts#L84">packages/client/src/lib/interface.ts:84</a></li>
103+
</ul>
104+
</aside>
105+
</section>
106+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
107+
<a name="deals" class="tsd-anchor"></a>
108+
<h3>deals</h3>
109+
<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>
110+
<aside class="tsd-sources">
111+
<ul>
112+
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/1dd1bd4/packages/client/src/lib/interface.ts#L86">packages/client/src/lib/interface.ts:86</a></li>
113+
</ul>
114+
</aside>
115+
</section>
116+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
117+
<a name="pin" class="tsd-anchor"></a>
118+
<h3>pin</h3>
119+
<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>
120+
<aside class="tsd-sources">
121+
<ul>
122+
<li>Defined in <a href="https://github.com/ipfs-shipyard/nft.storage/blob/1dd1bd4/packages/client/src/lib/interface.ts#L85">packages/client/src/lib/interface.ts:85</a></li>
123+
</ul>
124+
</aside>
125+
<div class="tsd-type-declaration">
126+
<h4>Type declaration</h4>
127+
<ul class="tsd-parameters">
128+
<li class="tsd-parameter">
129+
<h5>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></h5>
130+
</li>
131+
</ul>
132+
</div>
133+
</section>
134+
</section>
135+
</div>
136+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
137+
<nav class="tsd-navigation primary">
138+
<ul>
139+
<li class=" ">
140+
<a href="../modules.html">Modules</a>
141+
</li>
142+
<li class=" tsd-kind-module">
143+
<a href="../modules/gateway.html">gateway</a>
144+
</li>
145+
<li class=" tsd-kind-module">
146+
<a href="../modules/lib.html">lib</a>
147+
</li>
148+
<li class="current tsd-kind-module">
149+
<a href="../modules/lib_interface.html">lib/interface</a>
150+
</li>
151+
<li class=" tsd-kind-module">
152+
<a href="../modules/platform.html">platform</a>
153+
</li>
154+
<li class=" tsd-kind-module">
155+
<a href="../modules/platform_web.html">platform.web</a>
156+
</li>
157+
<li class=" tsd-kind-module">
158+
<a href="../modules/token.html">token</a>
159+
</li>
160+
</ul>
161+
</nav>
162+
<nav class="tsd-navigation secondary menu-sticky">
163+
<ul class="before-current">
164+
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
165+
<a href="../classes/lib_interface.CID.html" class="tsd-kind-icon">CID</a>
166+
</li>
167+
<li class=" tsd-kind-interface tsd-parent-kind-module">
168+
<a href="lib_interface.API.html" class="tsd-kind-icon">API</a>
169+
</li>
170+
</ul>
171+
<ul class="current">
172+
<li class="current tsd-kind-interface tsd-parent-kind-module">
173+
<a href="lib_interface.CheckResult.html" class="tsd-kind-icon">Check<wbr>Result</a>
174+
<ul>
175+
<li class=" tsd-kind-property tsd-parent-kind-interface">
176+
<a href="lib_interface.CheckResult.html#cid" class="tsd-kind-icon">cid</a>
177+
</li>
178+
<li class=" tsd-kind-property tsd-parent-kind-interface">
179+
<a href="lib_interface.CheckResult.html#deals" class="tsd-kind-icon">deals</a>
180+
</li>
181+
<li class=" tsd-kind-property tsd-parent-kind-interface">
182+
<a href="lib_interface.CheckResult.html#pin" class="tsd-kind-icon">pin</a>
183+
</li>
184+
</ul>
185+
</li>
186+
</ul>
187+
<ul class="after-current">
188+
<li class=" tsd-kind-interface tsd-parent-kind-module">
189+
<a href="lib_interface.DealInfo.html" class="tsd-kind-icon">Deal<wbr>Info</a>
190+
</li>
191+
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
192+
<a href="lib_interface.EncodedToken.html" class="tsd-kind-icon">Encoded<wbr>Token</a>
193+
</li>
194+
<li class=" tsd-kind-interface tsd-parent-kind-module">
195+
<a href="lib_interface.FailedDeal.html" class="tsd-kind-icon">Failed<wbr>Deal</a>
196+
</li>
197+
<li class=" tsd-kind-interface tsd-parent-kind-module">
198+
<a href="lib_interface.FinalizedDeal.html" class="tsd-kind-icon">Finalized<wbr>Deal</a>
199+
</li>
200+
<li class=" tsd-kind-interface tsd-parent-kind-module">
201+
<a href="lib_interface.PendingDeal.html" class="tsd-kind-icon">Pending<wbr>Deal</a>
202+
</li>
203+
<li class=" tsd-kind-interface tsd-parent-kind-module">
204+
<a href="lib_interface.Pin.html" class="tsd-kind-icon">Pin</a>
205+
</li>
206+
<li class=" tsd-kind-interface tsd-parent-kind-module">
207+
<a href="lib_interface.PublicService.html" class="tsd-kind-icon">Public<wbr>Service</a>
208+
</li>
209+
<li class=" tsd-kind-interface tsd-parent-kind-module">
210+
<a href="lib_interface.PublishedDeal.html" class="tsd-kind-icon">Published<wbr>Deal</a>
211+
</li>
212+
<li class=" tsd-kind-interface tsd-parent-kind-module">
213+
<a href="lib_interface.QueuedDeal.html" class="tsd-kind-icon">Queued<wbr>Deal</a>
214+
</li>
215+
<li class=" tsd-kind-interface tsd-parent-kind-module">
216+
<a href="lib_interface.Service.html" class="tsd-kind-icon">Service</a>
217+
</li>
218+
<li class=" tsd-kind-interface tsd-parent-kind-module">
219+
<a href="lib_interface.StatusResult.html" class="tsd-kind-icon">Status<wbr>Result</a>
220+
</li>
221+
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
222+
<a href="lib_interface.Token.html" class="tsd-kind-icon">Token</a>
223+
</li>
224+
<li class=" tsd-kind-interface tsd-parent-kind-module">
225+
<a href="lib_interface.TokenInput.html" class="tsd-kind-icon">Token<wbr>Input</a>
226+
</li>
227+
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
228+
<a href="../modules/lib_interface.html#CIDString" class="tsd-kind-icon">CIDString</a>
229+
</li>
230+
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
231+
<a href="../modules/lib_interface.html#CarReader" class="tsd-kind-icon">Car<wbr>Reader</a>
232+
</li>
233+
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
234+
<a href="../modules/lib_interface.html#Deal" class="tsd-kind-icon">Deal</a>
235+
</li>
236+
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
237+
<a href="../modules/lib_interface.html#Encoded" class="tsd-kind-icon">Encoded</a>
238+
</li>
239+
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
240+
<a href="../modules/lib_interface.html#EncodedError" class="tsd-kind-icon">Encoded<wbr>Error</a>
241+
</li>
242+
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
243+
<a href="../modules/lib_interface.html#EncodedURL" class="tsd-kind-icon">EncodedURL</a>
244+
</li>
245+
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
246+
<a href="../modules/lib_interface.html#MatchRecord" class="tsd-kind-icon">Match<wbr>Record</a>
247+
</li>
248+
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
249+
<a href="../modules/lib_interface.html#PinStatus" class="tsd-kind-icon">Pin<wbr>Status</a>
250+
</li>
251+
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
252+
<a href="../modules/lib_interface.html#Result" class="tsd-kind-icon">Result</a>
253+
</li>
254+
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
255+
<a href="../modules/lib_interface.html#StoreResponse" class="tsd-kind-icon">Store<wbr>Response</a>
256+
</li>
257+
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
258+
<a href="../modules/lib_interface.html#Tagged" class="tsd-kind-icon">Tagged</a>
259+
</li>
260+
</ul>
261+
</nav>
262+
</div>
263+
</div>
264+
</div>
265+
<footer class="with-border-bottom">
266+
<div class="container">
267+
<h2>Legend</h2>
268+
<div class="tsd-legend-group">
269+
<ul class="tsd-legend">
270+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
271+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
272+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
273+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
274+
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
275+
</ul>
276+
<ul class="tsd-legend">
277+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
278+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
279+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
280+
</ul>
281+
<ul class="tsd-legend">
282+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
283+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
284+
</ul>
285+
</div>
286+
</div>
287+
</footer>
288+
<div class="container tsd-generator">
289+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
290+
</div>
291+
<div class="overlay"></div>
292+
<script src="../assets/js/main.js"></script>
293+
</body>
294+
</html>

0 commit comments

Comments
 (0)