Skip to content

Commit c93da86

Browse files
willyliuwillyliu
committed
Updates docs.
1 parent 624662b commit c93da86

17 files changed

Lines changed: 12194 additions & 4347 deletions

‎docs/ast/source/Endpoint.js.json‎

Lines changed: 690 additions & 1107 deletions
Large diffs are not rendered by default.

‎docs/ast/source/api/ArtistFetcher.js.json‎

Lines changed: 3014 additions & 1230 deletions
Large diffs are not rendered by default.

‎docs/ast/source/api/ChartFetcher.js.json‎

Lines changed: 4550 additions & 753 deletions
Large diffs are not rendered by default.

‎docs/ast/source/api/NewHitsPlaylistFetcher.js.json‎

Lines changed: 2828 additions & 1044 deletions
Large diffs are not rendered by default.

‎docs/class/src/api/ArtistFetcher.js~ArtistFetcher.html‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,34 @@ <h1 data-ice="name">ArtistFetcher</h1>
164164

165165

166166

167+
<span class="override" data-ice="override"></span>
168+
</td>
169+
<td>
170+
<div>
171+
<p>
172+
173+
174+
<span data-ice="name"><span><a href="class/src/api/ArtistFetcher.js~ArtistFetcher.html#instance-method-fetchRelatedArtists">fetchRelatedArtists</a></span></span><span data-ice="signature">(limit: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, offset: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
175+
</p>
176+
</div>
177+
<div>
178+
179+
180+
<div data-ice="description"><p>Fetch related artists</p>
181+
</div>
182+
</div>
183+
</td>
184+
<td>
185+
186+
187+
</td>
188+
</tr>
189+
<tr data-ice="target">
190+
<td>
191+
<span class="access" data-ice="access">public</span>
192+
193+
194+
167195
<span class="override" data-ice="override"></span>
168196
</td>
169197
<td>
@@ -437,6 +465,93 @@ <h4>Example:</h4>
437465

438466
<div data-ice="see"><h4>See:</h4><ul><li><span><a href="https://docs-en.kkbox.codes/v1.1/reference#artists-artist_id">https://docs-en.kkbox.codes/v1.1/reference#artists-artist_id</a></span></li></ul></div>
439467

468+
</div>
469+
<div class="detail" data-ice="detail">
470+
<h3 data-ice="anchor" id="instance-method-fetchRelatedArtists">
471+
<span class="access" data-ice="access">public</span>
472+
473+
474+
475+
476+
477+
<span data-ice="name">fetchRelatedArtists</span><span data-ice="signature">(limit: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, offset: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
478+
<span class="right-info">
479+
480+
481+
<span data-ice="source"><span><a href="file/src/api/ArtistFetcher.js.html#lineNumber87">source</a></span></span>
482+
</span>
483+
</h3>
484+
485+
486+
487+
488+
<div data-ice="description"><p>Fetch related artists</p>
489+
</div>
490+
491+
492+
493+
<div data-ice="properties"><div data-ice="properties">
494+
<h4 data-ice="title">Params:</h4>
495+
<table class="params">
496+
<thead>
497+
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
498+
</thead>
499+
<tbody>
500+
501+
<tr data-ice="property" data-depth="0">
502+
<td data-ice="name" data-depth="0">limit</td>
503+
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></td>
504+
<td data-ice="appendix"><ul><li>optional</li></ul></td>
505+
<td data-ice="description"><p>The size for one page.</p>
506+
</td>
507+
</tr>
508+
<tr data-ice="property" data-depth="0">
509+
<td data-ice="name" data-depth="0">offset</td>
510+
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span></td>
511+
<td data-ice="appendix"><ul><li>optional</li></ul></td>
512+
<td data-ice="description"><p>The offset index for first element.</p>
513+
</td>
514+
</tr>
515+
</tbody>
516+
</table>
517+
</div>
518+
</div>
519+
520+
<div class="return-params" data-ice="returnParams">
521+
<h4>Return:</h4>
522+
<table>
523+
<tbody>
524+
<tr>
525+
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></td>
526+
527+
</tr>
528+
</tbody>
529+
</table>
530+
<div data-ice="returnProperties">
531+
</div>
532+
</div>
533+
534+
535+
536+
537+
538+
539+
540+
541+
542+
<div data-ice="example">
543+
<h4>Example:</h4>
544+
545+
<div class="example-doc" data-ice="exampleDoc">
546+
547+
<pre class="prettyprint source-code"><code data-ice="exampleCode">api.artistFetcher.setArtistID(&apos;Cnv_K6i5Ft4y41SxLy&apos;).fetchRelatedArtists()</code></pre>
548+
</div>
549+
</div>
550+
551+
552+
553+
<div data-ice="see"><h4>See:</h4><ul><li><span><a href="https://docs-en.kkbox.codes/v1.1/reference#artists-artist_id-relatedartists">https://docs-en.kkbox.codes/v1.1/reference#artists-artist_id-relatedartists</a></span></li></ul></div>
554+
440555
</div>
441556
<div class="detail" data-ice="detail">
442557
<h3 data-ice="anchor" id="instance-method-fetchTopTracks">

0 commit comments

Comments
 (0)