Skip to content
This repository has been archived by the owner on Jun 10, 2023. It is now read-only.

Commit

Permalink
Update docs, fix issues with new private members
Browse files Browse the repository at this point in the history
  • Loading branch information
@codyduong
codyduong committed Mar 17, 2022
1 parent bf81f02 commit 0398d92
Show file tree
Hide file tree
Showing 20 changed files with 406 additions and 663 deletions.
3 changes: 2 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ dist
yarn-error.log
coverage
TEST_setup.json
codyduong-ytmusicapi-*.tgz
codyduong-ytmusicapi-*.tgz
tscdocs
9 changes: 6 additions & 3 deletions docs/YTMusic.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
<body>

<nav class="navbar" id="navbar">
<div class="navbar-heading" id="navbar-heading"><a href="index.html"><h2 class="navbar-heading-text">Home</h2></a></div><div class="search-box" id="search-box"><div class="search-box-input-container"><input class="search-box-input" type="text" placeholder="Search..." id="search-box-input" /><svg class="search-icon" alt="search-icon"><use xlink:href="#search-icon"></use></svg></div><div class="search-item-container" id="search-item-container"><ul class="search-item-ul" id="search-item-ul"></ul></div></div><div class="sidebar-main-content" id="sidebar-main-content"><div class="accordion collapsed" id="713494" > <h3 class="accordion-heading">Modules<svg><use xlink:href="#down-icon"></use></svg></h3><ul class="accordion-content"><li class="accordion collapsed child" id=6572421><div class="accordion-heading child"><a href="module-Browsing.html">Browsing</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Browsing.html#getAlbum">getAlbum</a></li><li data-type='method'><a href="module-Browsing.html#getAlbumBrowseId">getAlbumBrowseId</a></li><li data-type='method'><a href="module-Browsing.html#getArtist">getArtist</a></li><li data-type='method'><a href="module-Browsing.html#getArtistAlbums">getArtistAlbums</a></li><li data-type='method'><a href="module-Browsing.html#getBaseJSUrl">getBaseJSUrl</a></li><li data-type='method'><a href="module-Browsing.html#getHome">getHome</a></li><li data-type='method'><a href="module-Browsing.html#getLyrics">getLyrics</a></li><li data-type='method'><a href="module-Browsing.html#getSignatureTimestamp">getSignatureTimestamp</a></li><li data-type='method'><a href="module-Browsing.html#getSong">getSong</a></li><li data-type='method'><a href="module-Browsing.html#getUser">getUser</a></li><li data-type='method'><a href="module-Browsing.html#getUserPlaylists">getUserPlaylists</a></li></ul></li><li class="accordion collapsed child" id=8102037><div class="accordion-heading child"><a href="module-Explore.html">Explore</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Explore.html#getCharts">getCharts</a></li><li data-type='method'><a href="module-Explore.html#getMoodCategories">getMoodCategories</a></li><li data-type='method'><a href="module-Explore.html#getMoodPlaylists">getMoodPlaylists</a></li></ul></li><li class="accordion collapsed child" id=5902337><div class="accordion-heading child"><a href="module-Library.html">Library</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Library.html#editSongLibraryStatus">editSongLibraryStatus</a></li><li data-type='method'><a href="module-Library.html#getHistory">getHistory</a></li><li data-type='method'><a href="module-Library.html#getLibraryAlbums">getLibraryAlbums</a></li><li data-type='method'><a href="module-Library.html#getLibraryArtists">getLibraryArtists</a></li><li data-type='method'><a href="module-Library.html#getLibraryPlaylists">getLibraryPlaylists</a></li><li data-type='method'><a href="module-Library.html#getLibrarySongs">getLibrarySongs</a></li><li data-type='method'><a href="module-Library.html#getLibrarySubscriptions">getLibrarySubscriptions</a></li><li data-type='method'><a href="module-Library.html#getLikedSongs">getLikedSongs</a></li><li data-type='method'><a href="module-Library.html#ratePlaylist">ratePlaylist</a></li><li data-type='method'><a href="module-Library.html#rateSong">rateSong</a></li><li data-type='method'><a href="module-Library.html#removeHistoryItems">removeHistoryItems</a></li><li data-type='method'><a href="module-Library.html#subscribeArtists">subscribeArtists</a></li><li data-type='method'><a href="module-Library.html#unsubscribeArtists">unsubscribeArtists</a></li></ul></li><li class="accordion collapsed child" id=7581247><div class="accordion-heading child"><a href="module-Playlists.html">Playlists</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Playlists.html#addPlaylistItems">addPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#editPlaylist">editPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#getPlaylist">getPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#getPlaylistSuggestions">getPlaylistSuggestions</a></li><li data-type='method'><a href="module-Playlists.html#removePlaylistItems">removePlaylistItems</a></li></ul></li><li class="accordion collapsed child" id=1125666><div class="accordion-heading child"><a href="module-Uploads.html">Uploads</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Uploads.html#deleteUploadEntity">deleteUploadEntity</a></li><li data-type='method'><a href="module-Uploads.html#getLibraryUploadAlbum">getLibraryUploadAlbum</a></li><li data-type='method'><a href="module-Uploads.html#getLibraryUploadArtist">getLibraryUploadArtist</a></li><li data-type='method'><a href="module-Uploads.html#uploadSong">uploadSong</a></li></ul></li><li class="accordion collapsed child" id=2120672><div class="accordion-heading child"><a href="module-Watch.html">Watch</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Watch.html#getWatchPlaylist">getWatchPlaylist</a></li><li data-type='method'><a href="module-Watch.html#getWatchPlaylistShuffle">getWatchPlaylistShuffle</a></li></ul></li></ul> </div><div class="accordion collapsed" id="1016159" > <h3 class="accordion-heading">Classes<svg><use xlink:href="#down-icon"></use></svg></h3><ul class="accordion-content"><li class="accordion-list" id=""><a href="YTMusic.html">YTMusic</a></li></ul> </div>
<div class="navbar-heading" id="navbar-heading"><a href="index.html"><h2 class="navbar-heading-text">Home</h2></a></div><div class="search-box" id="search-box"><div class="search-box-input-container"><input class="search-box-input" type="text" placeholder="Search..." id="search-box-input" /><svg class="search-icon" alt="search-icon"><use xlink:href="#search-icon"></use></svg></div><div class="search-item-container" id="search-item-container"><ul class="search-item-ul" id="search-item-ul"></ul></div></div><div class="sidebar-main-content" id="sidebar-main-content"><div class="accordion collapsed" id="4677886" > <h3 class="accordion-heading">Modules<svg><use xlink:href="#down-icon"></use></svg></h3><ul class="accordion-content"><li class="accordion collapsed child" id=9097033><div class="accordion-heading child"><a href="module-Browsing.html">Browsing</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Browsing.html#getAlbum">getAlbum</a></li><li data-type='method'><a href="module-Browsing.html#getAlbumBrowseId">getAlbumBrowseId</a></li><li data-type='method'><a href="module-Browsing.html#getArtist">getArtist</a></li><li data-type='method'><a href="module-Browsing.html#getArtistAlbums">getArtistAlbums</a></li><li data-type='method'><a href="module-Browsing.html#getBaseJSUrl">getBaseJSUrl</a></li><li data-type='method'><a href="module-Browsing.html#getHome">getHome</a></li><li data-type='method'><a href="module-Browsing.html#getLyrics">getLyrics</a></li><li data-type='method'><a href="module-Browsing.html#getSignatureTimestamp">getSignatureTimestamp</a></li><li data-type='method'><a href="module-Browsing.html#getSong">getSong</a></li><li data-type='method'><a href="module-Browsing.html#getUser">getUser</a></li><li data-type='method'><a href="module-Browsing.html#getUserPlaylists">getUserPlaylists</a></li></ul></li><li class="accordion collapsed child" id=4736079><div class="accordion-heading child"><a href="module-Explore.html">Explore</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Explore.html#getCharts">getCharts</a></li><li data-type='method'><a href="module-Explore.html#getMoodCategories">getMoodCategories</a></li><li data-type='method'><a href="module-Explore.html#getMoodPlaylists">getMoodPlaylists</a></li></ul></li><li class="accordion collapsed child" id=2449192><div class="accordion-heading child"><a href="module-Library.html">Library</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Library.html#editSongLibraryStatus">editSongLibraryStatus</a></li><li data-type='method'><a href="module-Library.html#getHistory">getHistory</a></li><li data-type='method'><a href="module-Library.html#getLibraryAlbums">getLibraryAlbums</a></li><li data-type='method'><a href="module-Library.html#getLibraryArtists">getLibraryArtists</a></li><li data-type='method'><a href="module-Library.html#getLibraryPlaylists">getLibraryPlaylists</a></li><li data-type='method'><a href="module-Library.html#getLibrarySongs">getLibrarySongs</a></li><li data-type='method'><a href="module-Library.html#getLibrarySubscriptions">getLibrarySubscriptions</a></li><li data-type='method'><a href="module-Library.html#getLikedSongs">getLikedSongs</a></li><li data-type='method'><a href="module-Library.html#ratePlaylist">ratePlaylist</a></li><li data-type='method'><a href="module-Library.html#rateSong">rateSong</a></li><li data-type='method'><a href="module-Library.html#removeHistoryItems">removeHistoryItems</a></li><li data-type='method'><a href="module-Library.html#subscribeArtists">subscribeArtists</a></li><li data-type='method'><a href="module-Library.html#unsubscribeArtists">unsubscribeArtists</a></li></ul></li><li class="accordion collapsed child" id=5846378><div class="accordion-heading child"><a href="module-Playlists.html">Playlists</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Playlists.html#addPlaylistItems">addPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#editPlaylist">editPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#getPlaylist">getPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#getPlaylistSuggestions">getPlaylistSuggestions</a></li><li data-type='method'><a href="module-Playlists.html#removePlaylistItems">removePlaylistItems</a></li></ul></li><li class="accordion collapsed child" id=4179787><div class="accordion-heading child"><a href="module-Uploads.html">Uploads</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Uploads.html#deleteUploadEntity">deleteUploadEntity</a></li><li data-type='method'><a href="module-Uploads.html#getLibraryUploadAlbum">getLibraryUploadAlbum</a></li><li data-type='method'><a href="module-Uploads.html#getLibraryUploadArtist">getLibraryUploadArtist</a></li><li data-type='method'><a href="module-Uploads.html#uploadSong">uploadSong</a></li></ul></li><li class="accordion collapsed child" id=7291723><div class="accordion-heading child"><a href="module-Watch.html">Watch</a><svg><use xlink:href="#down-icon"></use></svg></div><ul class='methods accordion-content'><li data-type='method'><a href="module-Watch.html#getWatchPlaylist">getWatchPlaylist</a></li><li data-type='method'><a href="module-Watch.html#getWatchPlaylistShuffle">getWatchPlaylistShuffle</a></li></ul></li></ul> </div><div class="accordion collapsed" id="7359264" > <h3 class="accordion-heading">Classes<svg><use xlink:href="#down-icon"></use></svg></h3><ul class="accordion-content"><li class="accordion-list" id=""><a href="YTMusic.html">YTMusic</a></li></ul> </div>


</nav>
Expand Down Expand Up @@ -220,6 +220,9 @@ <h4 class="name" id="YTMusic">


<span class="param-type">string</span>
|

<span class="param-type">object</span>



Expand All @@ -239,7 +242,7 @@ <h4 class="name" id="YTMusic">



<td class="description last">Provide a string or path to file.Authentication credentials are needed to manage your library.Should be an adjusted version of `headers_auth.json.example` in the project root.See `setup` for how to fill in the correct credentials.If not provided, a default header is used without authentication.</td>
<td class="description last">Provide a string (raw headers), object, or path (Node only!),Authentication credentials are needed to manage your library.Should be an adjusted version of `headers_auth.json.example` in the project root.See `setup` for how to fill in the correct credentials.If not provided, a default header is used without authentication.</td>
</tr>


Expand Down Expand Up @@ -383,7 +386,7 @@ <h4 class="name" id="YTMusic">
<div class="details-item-container">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line30">line 30</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line32">line 32</a>
</li></ul></dd>
</div>

Expand Down
Loading

0 comments on commit 0398d92

Please sign in to comment.