Skip to content

Commit eb2e906

Browse files
committed
Update docs
1 parent 18023d8 commit eb2e906

24 files changed

+576
-2926
lines changed

doc/assets/css/main.css

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

doc/assets/js/main.js

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

doc/assets/js/search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

doc/classes/_imdb_.client.html

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ <h3>constructor</h3>
133133
<li class="tsd-description">
134134
<aside class="tsd-sources">
135135
<ul>
136-
<li>Defined in <a href="https://github.com/worr/node-imdb-api/blob/51a40d9/src/imdb.ts#L621">imdb.ts:621</a></li>
136+
<li>Defined in imdb.ts:699</li>
137137
</ul>
138138
</aside>
139139
<div class="tsd-comment tsd-typography">
@@ -175,7 +175,7 @@ <h3>get</h3>
175175
<li class="tsd-description">
176176
<aside class="tsd-sources">
177177
<ul>
178-
<li>Defined in <a href="https://github.com/worr/node-imdb-api/blob/51a40d9/src/imdb.ts#L646">imdb.ts:646</a></li>
178+
<li>Defined in imdb.ts:732</li>
179179
</ul>
180180
</aside>
181181
<div class="tsd-comment tsd-typography">
@@ -207,13 +207,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
207207
<a name="search" class="tsd-anchor"></a>
208208
<h3>search</h3>
209209
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
210-
<li class="tsd-signature tsd-kind-icon">search<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_imdb_.searchrequest.html" class="tsd-signature-type">SearchRequest</a>, page<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_imdb_.movieopts.html" class="tsd-signature-type">MovieOpts</a><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="_imdb_.searchresults.html" class="tsd-signature-type">SearchResults</a><span class="tsd-signature-symbol">&gt;</span></li>
210+
<li class="tsd-signature tsd-kind-icon">search<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_imdb_.searchrequest.html" class="tsd-signature-type">SearchRequest</a>, page<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_imdb_.movieopts.html" class="tsd-signature-type">MovieOpts</a><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="_imdb_.searchresults.html" class="tsd-signature-type">SearchResults</a><span class="tsd-signature-symbol">&gt;</span></li>
211211
</ul>
212212
<ul class="tsd-descriptions">
213213
<li class="tsd-description">
214214
<aside class="tsd-sources">
215215
<ul>
216-
<li>Defined in <a href="https://github.com/worr/node-imdb-api/blob/51a40d9/src/imdb.ts#L714">imdb.ts:714</a></li>
216+
<li>Defined in imdb.ts:811</li>
217217
</ul>
218218
</aside>
219219
<div class="tsd-comment tsd-typography">
@@ -230,7 +230,7 @@ <h5>req: <a href="../interfaces/_imdb_.searchrequest.html" class="tsd-signature-
230230
</div>
231231
</li>
232232
<li>
233-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> page: <span class="tsd-signature-type">number</span></h5>
233+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> page: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
234234
<div class="tsd-comment tsd-typography">
235235
<p>page number to return</p>
236236
</div>
@@ -328,6 +328,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
328328
<li class=" tsd-kind-function tsd-parent-kind-module">
329329
<a href="../modules/_imdb_.html#get" class="tsd-kind-icon">get</a>
330330
</li>
331+
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
332+
<a href="../modules/_imdb_.html#isrequesttype" class="tsd-kind-icon">is<wbr>Request<wbr>Type</a>
333+
</li>
331334
<li class=" tsd-kind-function tsd-parent-kind-module">
332335
<a href="../modules/_imdb_.html#search" class="tsd-kind-icon">search</a>
333336
</li>

doc/classes/_imdb_.episode.html

Lines changed: 40 additions & 37 deletions
Large diffs are not rendered by default.

doc/classes/_imdb_.imdberror.html

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ <h3>constructor</h3>
109109
<li class="tsd-description">
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/worr/node-imdb-api/blob/51a40d9/src/imdb.ts#L554">imdb.ts:554</a></li>
112+
<li>Defined in imdb.ts:627</li>
113113
</ul>
114114
</aside>
115115
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -131,7 +131,7 @@ <h3>message</h3>
131131
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
132132
<aside class="tsd-sources">
133133
<ul>
134-
<li>Defined in <a href="https://github.com/worr/node-imdb-api/blob/51a40d9/src/imdb.ts#L556">imdb.ts:556</a></li>
134+
<li>Defined in imdb.ts:629</li>
135135
</ul>
136136
</aside>
137137
</section>
@@ -141,7 +141,7 @@ <h3>name</h3>
141141
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;imdb api error&quot;</span></div>
142142
<aside class="tsd-sources">
143143
<ul>
144-
<li>Defined in <a href="https://github.com/worr/node-imdb-api/blob/51a40d9/src/imdb.ts#L554">imdb.ts:554</a></li>
144+
<li>Defined in imdb.ts:627</li>
145145
</ul>
146146
</aside>
147147
</section>
@@ -226,6 +226,9 @@ <h3>name</h3>
226226
<li class=" tsd-kind-function tsd-parent-kind-module">
227227
<a href="../modules/_imdb_.html#get" class="tsd-kind-icon">get</a>
228228
</li>
229+
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
230+
<a href="../modules/_imdb_.html#isrequesttype" class="tsd-kind-icon">is<wbr>Request<wbr>Type</a>
231+
</li>
229232
<li class=" tsd-kind-function tsd-parent-kind-module">
230233
<a href="../modules/_imdb_.html#search" class="tsd-kind-icon">search</a>
231234
</li>

0 commit comments

Comments
 (0)