@kkbox/kkbox-js-sdk
Version:
KKBOX Open API developer SDK for JavaScript. Use it to easily access KKBOX open API to get various metadata about KKBOX's tracks, albums, artists, playlists and stations.
278 lines (267 loc) • 21.2 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="">
<title data-ice="title">Source | @kkbox/kkbox-js-sdk</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
<meta name="description" content="KKBOX Open API Developer SDK for JavaScript"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="@kkbox/kkbox-js-sdk"><meta property="twitter:description" content="KKBOX Open API Developer SDK for JavaScript"></head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
<a style="position:relative; top:3px;" href="https://github.com/KKBOX/OpenAPI-JavaScript"><img width="20px" src="./image/github.png"></a></header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#api">api</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/AlbumFetcher.js~AlbumFetcher.html">AlbumFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/Api.js~Api.html">Api</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/ArtistFetcher.js~ArtistFetcher.html">ArtistFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/ChartFetcher.js~ChartFetcher.html">ChartFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/FeaturedPlaylistCategoryFetcher.js~FeaturedPlaylistCategoryFetcher.html">FeaturedPlaylistCategoryFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/FeaturedPlaylistFetcher.js~FeaturedPlaylistFetcher.html">FeaturedPlaylistFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/Fetcher.js~Fetcher.html">Fetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/GenreStationFetcher.js~GenreStationFetcher.html">GenreStationFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/HttpClient.js~HttpClient.html">HttpClient</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/MoodStationFetcher.js~MoodStationFetcher.html">MoodStationFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/NewHitsPlaylistFetcher.js~NewHitsPlaylistFetcher.html">NewHitsPlaylistFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/NewReleaseCategoryFetcher.js~NewReleaseCategoryFetcher.html">NewReleaseCategoryFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/SearchFetcher.js~SearchFetcher.html">SearchFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/SharedPlaylistFetcher.js~SharedPlaylistFetcher.html">SharedPlaylistFetcher</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/TrackFetcher.js~TrackFetcher.html">TrackFetcher</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#auth">auth</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/auth/Auth.js~Auth.html">Auth</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/auth/ClientCredentialsFlow.js~ClientCredentialsFlow.html">ClientCredentialsFlow</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/auth/TokenFetcher.js~TokenFetcher.html">TokenFetcher</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><h1>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">122/134</span></h1>
<table class="files-summary" data-ice="files" data-use-coverage="true">
<thead>
<tr>
<td>File</td>
<td>Identifier</td>
<td class="coverage">Document</td>
<td style="display: none;">Size</td>
<td style="display: none;">Lines</td>
<td style="display: none;">Updated</td>
</tr>
</thead>
<tbody>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/Endpoint.js.html#errorLines=1,2">src/Endpoint.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">0 %</span><span data-ice="coverageCount" class="coverage-count">0/2</span></td>
<td style="display: none;" data-ice="size">783 byte</td>
<td style="display: none;" data-ice="lines">19</td>
<td style="display: none;" data-ice="updated">2018-06-07 05:49:00 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/AlbumFetcher.js.html">src/api/AlbumFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/AlbumFetcher.js~AlbumFetcher.html">AlbumFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">7/7</span></td>
<td style="display: none;" data-ice="size">1877 byte</td>
<td style="display: none;" data-ice="lines">71</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/Api.js.html#errorLines=28,29">src/api/Api.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/Api.js~Api.html">Api</a></span></td>
<td class="coverage"><span data-ice="coverage">88 %</span><span data-ice="coverageCount" class="coverage-count">15/17</span></td>
<td style="display: none;" data-ice="size">3198 byte</td>
<td style="display: none;" data-ice="lines">123</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/ArtistFetcher.js.html">src/api/ArtistFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/ArtistFetcher.js~ArtistFetcher.html">ArtistFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">8/8</span></td>
<td style="display: none;" data-ice="size">2780 byte</td>
<td style="display: none;" data-ice="lines">96</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/ChartFetcher.js.html">src/api/ChartFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/ChartFetcher.js~ChartFetcher.html">ChartFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">7/7</span></td>
<td style="display: none;" data-ice="size">1962 byte</td>
<td style="display: none;" data-ice="lines">75</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/FeaturedPlaylistCategoryFetcher.js.html">src/api/FeaturedPlaylistCategoryFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/FeaturedPlaylistCategoryFetcher.js~FeaturedPlaylistCategoryFetcher.html">FeaturedPlaylistCategoryFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">7/7</span></td>
<td style="display: none;" data-ice="size">2286 byte</td>
<td style="display: none;" data-ice="lines">75</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/FeaturedPlaylistFetcher.js.html">src/api/FeaturedPlaylistFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/FeaturedPlaylistFetcher.js~FeaturedPlaylistFetcher.html">FeaturedPlaylistFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">3/3</span></td>
<td style="display: none;" data-ice="size">922 byte</td>
<td style="display: none;" data-ice="lines">32</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/Fetcher.js.html">src/api/Fetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/Fetcher.js~Fetcher.html">Fetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">8/8</span></td>
<td style="display: none;" data-ice="size">2921 byte</td>
<td style="display: none;" data-ice="lines">98</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/GenreStationFetcher.js.html">src/api/GenreStationFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/GenreStationFetcher.js~GenreStationFetcher.html">GenreStationFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">6/6</span></td>
<td style="display: none;" data-ice="size">1698 byte</td>
<td style="display: none;" data-ice="lines">62</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/HttpClient.js.html">src/api/HttpClient.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/HttpClient.js~HttpClient.html">HttpClient</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">5/5</span></td>
<td style="display: none;" data-ice="size">1066 byte</td>
<td style="display: none;" data-ice="lines">53</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/MoodStationFetcher.js.html#errorLines=44">src/api/MoodStationFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/MoodStationFetcher.js~MoodStationFetcher.html">MoodStationFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">85 %</span><span data-ice="coverageCount" class="coverage-count">6/7</span></td>
<td style="display: none;" data-ice="size">1570 byte</td>
<td style="display: none;" data-ice="lines">60</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/NewHitsPlaylistFetcher.js.html">src/api/NewHitsPlaylistFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/NewHitsPlaylistFetcher.js~NewHitsPlaylistFetcher.html">NewHitsPlaylistFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">7/7</span></td>
<td style="display: none;" data-ice="size">2255 byte</td>
<td style="display: none;" data-ice="lines">77</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/NewReleaseCategoryFetcher.js.html">src/api/NewReleaseCategoryFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/NewReleaseCategoryFetcher.js~NewReleaseCategoryFetcher.html">NewReleaseCategoryFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">7/7</span></td>
<td style="display: none;" data-ice="size">2398 byte</td>
<td style="display: none;" data-ice="lines">79</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/SearchFetcher.js.html#errorLines=91">src/api/SearchFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/SearchFetcher.js~SearchFetcher.html">SearchFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">88 %</span><span data-ice="coverageCount" class="coverage-count">8/9</span></td>
<td style="display: none;" data-ice="size">6101 byte</td>
<td style="display: none;" data-ice="lines">201</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/SharedPlaylistFetcher.js.html">src/api/SharedPlaylistFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/SharedPlaylistFetcher.js~SharedPlaylistFetcher.html">SharedPlaylistFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">7/7</span></td>
<td style="display: none;" data-ice="size">2065 byte</td>
<td style="display: none;" data-ice="lines">77</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/TrackFetcher.js.html">src/api/TrackFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/TrackFetcher.js~TrackFetcher.html">TrackFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">6/6</span></td>
<td style="display: none;" data-ice="size">1278 byte</td>
<td style="display: none;" data-ice="lines">54</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/auth/Auth.js.html">src/auth/Auth.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/auth/Auth.js~Auth.html">Auth</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">4/4</span></td>
<td style="display: none;" data-ice="size">684 byte</td>
<td style="display: none;" data-ice="lines">26</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/auth/ClientCredentialsFlow.js.html">src/auth/ClientCredentialsFlow.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/auth/ClientCredentialsFlow.js~ClientCredentialsFlow.html">ClientCredentialsFlow</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">4/4</span></td>
<td style="display: none;" data-ice="size">579 byte</td>
<td style="display: none;" data-ice="lines">28</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/auth/TokenFetcher.js.html">src/auth/TokenFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/auth/TokenFetcher.js~TokenFetcher.html">TokenFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">5/5</span></td>
<td style="display: none;" data-ice="size">810 byte</td>
<td style="display: none;" data-ice="lines">42</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/catchError.js.html">src/catchError.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">2/2</span></td>
<td style="display: none;" data-ice="size">293 byte</td>
<td style="display: none;" data-ice="lines">17</td>
<td style="display: none;" data-ice="updated">2018-06-06 09:08:40 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/index.js.html">src/index.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">-</span></td>
<td style="display: none;" data-ice="size">91 byte</td>
<td style="display: none;" data-ice="lines">2</td>
<td style="display: none;" data-ice="updated">2018-06-07 02:54:18 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/test/apitest.js.html#errorLines=18,19">src/test/apitest.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">0 %</span><span data-ice="coverageCount" class="coverage-count">0/2</span></td>
<td style="display: none;" data-ice="size">24867 byte</td>
<td style="display: none;" data-ice="lines">655</td>
<td style="display: none;" data-ice="updated">2018-06-07 06:32:06 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/test/authtest.js.html#errorLines=6,7">src/test/authtest.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">0 %</span><span data-ice="coverageCount" class="coverage-count">0/2</span></td>
<td style="display: none;" data-ice="size">816 byte</td>
<td style="display: none;" data-ice="lines">22</td>
<td style="display: none;" data-ice="updated">2018-06-07 06:06:51 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/test/sdktest.js.html#errorLines=5,6">src/test/sdktest.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">0 %</span><span data-ice="coverageCount" class="coverage-count">0/2</span></td>
<td style="display: none;" data-ice="size">5414 byte</td>
<td style="display: none;" data-ice="lines">153</td>
<td style="display: none;" data-ice="updated">2018-06-07 06:06:51 (UTC)</td>
</tr>
</tbody>
</table>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.1.0)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>