Renamed ytmusic-methods to ytmusic
This commit is contained in:
Zechariah
parent
4a181fdbf7
commit
9c08ac660e
|
|
@ -10,7 +10,7 @@ export default defineUserConfig<DefaultThemeOptions>({
|
|||
navbar: [
|
||||
{ text: "Home", link: "/" },
|
||||
{ text: "Guides", link: "/guides/getting-started.html" },
|
||||
{ text: "References", link: "/references/ytmusic-methods/getSearchSuggestions.html" }
|
||||
{ text: "References", link: "/references/ytmusic/getSearchSuggestions.html" }
|
||||
],
|
||||
sidebar: [
|
||||
{
|
||||
|
|
@ -94,67 +94,67 @@ export default defineUserConfig<DefaultThemeOptions>({
|
|||
collapsible: true,
|
||||
children: [
|
||||
{
|
||||
text: "YTMusic Methods",
|
||||
text: "YTMusic Class",
|
||||
children: [
|
||||
{
|
||||
text: "getSearchSuggestions",
|
||||
link: "/references/ytmusic-methods/getSearchSuggestions.html"
|
||||
link: "/references/ytmusic/getSearchSuggestions.html"
|
||||
},
|
||||
{
|
||||
text: "search",
|
||||
link: "/references/ytmusic-methods/search.html"
|
||||
link: "/references/ytmusic/search.html"
|
||||
},
|
||||
{
|
||||
text: "searchSongs",
|
||||
link: "/references/ytmusic-methods/searchSongs.html"
|
||||
link: "/references/ytmusic/searchSongs.html"
|
||||
},
|
||||
{
|
||||
text: "searchVideos",
|
||||
link: "/references/ytmusic-methods/searchVideos.html"
|
||||
link: "/references/ytmusic/searchVideos.html"
|
||||
},
|
||||
{
|
||||
text: "searchArtists",
|
||||
link: "/references/ytmusic-methods/searchArtists.html"
|
||||
link: "/references/ytmusic/searchArtists.html"
|
||||
},
|
||||
{
|
||||
text: "searchAlbums",
|
||||
link: "/references/ytmusic-methods/searchAlbums.html"
|
||||
link: "/references/ytmusic/searchAlbums.html"
|
||||
},
|
||||
{
|
||||
text: "searchPlaylists",
|
||||
link: "/references/ytmusic-methods/searchPlaylists.html"
|
||||
link: "/references/ytmusic/searchPlaylists.html"
|
||||
},
|
||||
{
|
||||
text: "getSong",
|
||||
link: "/references/ytmusic-methods/getSong.html"
|
||||
link: "/references/ytmusic/getSong.html"
|
||||
},
|
||||
{
|
||||
text: "getVideo",
|
||||
link: "/references/ytmusic-methods/getVideo.html"
|
||||
link: "/references/ytmusic/getVideo.html"
|
||||
},
|
||||
{
|
||||
text: "getArtist",
|
||||
link: "/references/ytmusic-methods/getArtist.html"
|
||||
link: "/references/ytmusic/getArtist.html"
|
||||
},
|
||||
{
|
||||
text: "getArtistSongs",
|
||||
link: "/references/ytmusic-methods/getArtistSongs.html"
|
||||
link: "/references/ytmusic/getArtistSongs.html"
|
||||
},
|
||||
{
|
||||
text: "getArtistAlbums",
|
||||
link: "/references/ytmusic-methods/getArtistAlbums.html"
|
||||
link: "/references/ytmusic/getArtistAlbums.html"
|
||||
},
|
||||
{
|
||||
text: "getAlbum",
|
||||
link: "/references/ytmusic-methods/getAlbum.html"
|
||||
link: "/references/ytmusic/getAlbum.html"
|
||||
},
|
||||
{
|
||||
text: "getPlaylist",
|
||||
link: "/references/ytmusic-methods/getPlaylist.html"
|
||||
link: "/references/ytmusic/getPlaylist.html"
|
||||
},
|
||||
{
|
||||
text: "getPlaylistVideos",
|
||||
link: "/references/ytmusic-methods/getPlaylistVideos.html"
|
||||
link: "/references/ytmusic/getPlaylistVideos.html"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.getAlbum("MPREb_iG5q5DIdhdA").then(album => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/getAlbum.html) for more information.
|
||||
See the [reference](../../references/ytmusic/getAlbum.html) for more information.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.getArtist("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artist => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/getArtist.html) for more information.
|
||||
See the [reference](../../references/ytmusic/getArtist.html) for more information.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.getArtistAlbums("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistAlbums => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/getArtistAlbums.html) for more information.
|
||||
See the [reference](../../references/ytmusic/getArtistAlbums.html) for more information.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.getArtistSongs("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistSongs => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/getArtistSongs.html) for more information.
|
||||
See the [reference](../../references/ytmusic/getArtistSongs.html) for more information.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.getPlaylist("OLAK5uy_nRb467jR73IXKybwzw22_rTYIJ808x4Yc").then(playlist =
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/getPlaylist.html) for more information.
|
||||
See the [reference](../../references/ytmusic/getPlaylist.html) for more information.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.getPlaylistVideos("OLAK5uy_nRb467jR73IXKybwzw22_rTYIJ808x4Yc").then(play
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/getPlaylistVideos.html) for more information.
|
||||
See the [reference](../../references/ytmusic/getPlaylistVideos.html) for more information.
|
||||
|
|
|
|||
|
|
@ -17,4 +17,4 @@ ytmusic.getSearchSuggestions("Lilac").then(res => {
|
|||
// > ]
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/getSearchSuggestions.html) for information.
|
||||
See the [reference](../../references/ytmusic/getSearchSuggestions.html) for information.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.getSong("v7bnOxV4jAc").then(song => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/getSong.html) for more information.
|
||||
See the [reference](../../references/ytmusic/getSong.html) for more information.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.getVideo("v7bnOxV4jAc").then(video => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/getVideo.html) for more information.
|
||||
See the [reference](../../references/ytmusic/getVideo.html) for more information.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.search("Lilac").then(results => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/search.html) for information.
|
||||
See the [reference](../../references/ytmusic/search.html) for information.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.searchAlbums("Lilac").then(albums => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/searchAlbums.html) for information.
|
||||
See the [reference](../../references/ytmusic/searchAlbums.html) for information.
|
||||
|
|
@ -8,4 +8,4 @@ ytmusic.searchArtists("Lilac").then(artists => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/searchArtists.html) for information.
|
||||
See the [reference](../../references/ytmusic/searchArtists.html) for information.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ytmusic.searchPlaylists("Lilac").then(playlists => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/searchPlaylists.html) for information.
|
||||
See the [reference](../../references/ytmusic/searchPlaylists.html) for information.
|
||||
|
|
@ -8,4 +8,4 @@ ytmusic.searchSongs("Lilac").then(songs => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/searchSongs.html) for information.
|
||||
See the [reference](../../references/ytmusic/searchSongs.html) for information.
|
||||
|
|
@ -8,4 +8,4 @@ ytmusic.searchVideos("Lilac").then(videos => {
|
|||
})
|
||||
```
|
||||
|
||||
See the [reference](../../references/ytmusic-methods/searchVideos.html) for information.
|
||||
See the [reference](../../references/ytmusic/searchVideos.html) for information.
|
||||
|
|
|
|||
|
|
@ -32,6 +32,6 @@ interface AlbumDetailed {
|
|||
|
||||
[SearchResult](../types/SearchResult.html)
|
||||
|
||||
[YTMusic#searchAlbums](../ytmusic-methods/searchAlbums.html)
|
||||
[YTMusic#searchAlbums](../ytmusic/searchAlbums.html)
|
||||
|
||||
[YTMusic#getArtistAlbums](../ytmusic-methods/getArtistAlbums.html)
|
||||
[YTMusic#getArtistAlbums](../ytmusic/getArtistAlbums.html)
|
||||
|
|
@ -32,4 +32,4 @@ interface AlbumFull {
|
|||
|
||||
## Usages
|
||||
|
||||
[YTMusic#getAlbum](../ytmusic-methods/getAlbum.md)
|
||||
[YTMusic#getAlbum](../ytmusic/getAlbum.md)
|
||||
|
|
|
|||
|
|
@ -24,4 +24,4 @@ interface ArtistDetailed {
|
|||
|
||||
[SearchResult](../types/SearchResult.html)
|
||||
|
||||
[YTMusic#searchArtists](../ytmusic-methods/searchArtists.html)
|
||||
[YTMusic#searchArtists](../ytmusic/searchArtists.html)
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ interface ArtistFull {
|
|||
|
||||
## Usages
|
||||
|
||||
[YTMusic#getArtist](../ytmusic-methods/getArtist.html)
|
||||
[YTMusic#getArtist](../ytmusic/getArtist.html)
|
||||
|
|
|
|||
|
|
@ -28,6 +28,6 @@ interface PlaylistFull {
|
|||
|
||||
[SearchResult](../types/SearchResult.html)
|
||||
|
||||
[YTMusic#searchPlaylists](../ytmusic-methods/searchPlaylists.html)
|
||||
[YTMusic#searchPlaylists](../ytmusic/searchPlaylists.html)
|
||||
|
||||
[YTMusic#getPlaylist](../ytmusic-methods/getPlaylist.html)
|
||||
[YTMusic#getPlaylist](../ytmusic/getPlaylist.html)
|
||||
|
|
|
|||
|
|
@ -34,6 +34,6 @@ interface SongDetailed {
|
|||
|
||||
[SearchResult](../types/SearchResult.html)
|
||||
|
||||
[YTMusic#searchSongs](../ytmusic-methods/searchSongs.html)
|
||||
[YTMusic#searchSongs](../ytmusic/searchSongs.html)
|
||||
|
||||
[YTMusic#getArtistSongs](../ytmusic-methods/getArtistSongs.html)
|
||||
[YTMusic#getArtistSongs](../ytmusic/getArtistSongs.html)
|
||||
|
|
|
|||
|
|
@ -32,4 +32,4 @@ interface SongFull {
|
|||
|
||||
## Usages
|
||||
|
||||
[YTMusic#getSong](../ytmusic-methods/getSong.html)
|
||||
[YTMusic#getSong](../ytmusic/getSong.html)
|
||||
|
|
|
|||
|
|
@ -30,6 +30,6 @@ interface VideoDetailed {
|
|||
|
||||
[SearchResult](../types/SearchResult.html)
|
||||
|
||||
[YTMusic#searchVideos](../ytmusic-methods/searchVideos.html)
|
||||
[YTMusic#searchVideos](../ytmusic/searchVideos.html)
|
||||
|
||||
[YTMusic#getPlaylistVideos](../ytmusic-methods/getPlaylistVideos.html)
|
||||
[YTMusic#getPlaylistVideos](../ytmusic/getPlaylistVideos.html)
|
||||
|
|
|
|||
|
|
@ -38,4 +38,4 @@ interface VideoFull {
|
|||
|
||||
## Usages
|
||||
|
||||
[YTMusic#getVideo](../ytmusic-methods/getVideo.html)
|
||||
[YTMusic#getVideo](../ytmusic/getVideo.html)
|
||||
|
|
|
|||
|
|
@ -1,170 +0,0 @@
|
|||
# References
|
||||
|
||||
## `YTMusic` methods
|
||||
|
||||
### `getSearchSuggestions`
|
||||
|
||||
::: tip Properties
|
||||
|
||||
| Name | Data Type | Description |
|
||||
| :------ | :-------- | :------------------------------------ |
|
||||
| `query` | `string` | Search query you want suggestions for |
|
||||
|
||||
:::
|
||||
|
||||
::: tip Returns
|
||||
|
||||
`Promise<string[]>`
|
||||
|
||||
:::
|
||||
|
||||
```ts
|
||||
public async getSearchSuggestions(query: string): Promise<string[]>
|
||||
```
|
||||
|
||||
### `search`
|
||||
|
||||
::: tip Properties
|
||||
|
||||
| Name | Data Type | Description |
|
||||
| :------ | :-------- | :----------- |
|
||||
| `query` | `string` | Search query |
|
||||
|
||||
:::
|
||||
|
||||
::: tip Returns
|
||||
|
||||
<code class="code-left">Promise<</code>
|
||||
<a class="anchor" href="#searchresult">SearchResult</a>
|
||||
<code class="code-right">[]></code>
|
||||
|
||||
:::
|
||||
|
||||
```ts
|
||||
public async search(query: string): Promise<SearchResult[]>
|
||||
```
|
||||
|
||||
#### `search` for songs
|
||||
|
||||
::: tip Properties
|
||||
|
||||
| Name | Data Type | Description |
|
||||
| :--------- | :--------- | :----------------------------- |
|
||||
| `query` | `string` | Search query |
|
||||
| `category` | `"STRING"` | Category of results to receive |
|
||||
|
||||
:::
|
||||
|
||||
::: tip Returns
|
||||
|
||||
<code class="code-left">Promise<</code>
|
||||
<a class="anchor" href="#songdetailed">SongDetailed</a>
|
||||
<code class="code-right">[]></code>
|
||||
|
||||
:::
|
||||
|
||||
```ts
|
||||
public async search(query: string, category: "SONG"): Promise<SongDetailed[]>
|
||||
```
|
||||
|
||||
#### `search` for videos
|
||||
|
||||
::: tip Properties
|
||||
|
||||
| Name | Data Type | Description |
|
||||
| :--------- | :-------- | :----------------------------- |
|
||||
| `query` | `string` | Search query |
|
||||
| `category` | `"VIDEO"` | Category of results to receive |
|
||||
|
||||
:::
|
||||
|
||||
```ts
|
||||
public async search(query: string, category: "VIDEO"): Promise<VideoDetailed[]>
|
||||
```
|
||||
|
||||
#### `search` for artists
|
||||
|
||||
::: tip Properties
|
||||
|
||||
| Name | Data Type | Description |
|
||||
| :--------- | :--------- | :----------------------------- |
|
||||
| `query` | `string` | Search query |
|
||||
| `category` | `"ARTIST"` | Category of results to receive |
|
||||
|
||||
:::
|
||||
|
||||
```ts
|
||||
public async search(query: string, category: "ARTIST"): Promise<ArtistDetailed[]>
|
||||
```
|
||||
|
||||
#### `search` for albums
|
||||
|
||||
::: tip Properties
|
||||
|
||||
| Name | Data Type | Description |
|
||||
| :--------- | :-------- | :----------------------------- |
|
||||
| `query` | `string` | Search query |
|
||||
| `category` | `"ALBUM"` | Category of results to receive |
|
||||
|
||||
:::
|
||||
|
||||
```ts
|
||||
public async search(query: string, category: "ALBUM"): Promise<AlbumDetailed[]>
|
||||
```
|
||||
|
||||
#### `search` for playlists
|
||||
|
||||
::: tip Properties
|
||||
|
||||
| Name | Data Type | Description |
|
||||
| :--------- | :----------- | :----------------------------- |
|
||||
| `query` | `string` | Search query |
|
||||
| `category` | `"PLAYLIST"` | Category of results to receive |
|
||||
|
||||
:::
|
||||
|
||||
```ts
|
||||
public async search(query: string, category: "PLAYLIST"): Promise<PlaylistFull[]>
|
||||
```
|
||||
|
||||
### `getSong`
|
||||
|
||||
### `getVideo`
|
||||
|
||||
### `getArtist`
|
||||
|
||||
### `getArtistVideo`
|
||||
|
||||
### `getArtistAlbums`
|
||||
|
||||
### `getAlbum`
|
||||
|
||||
### `getPlaylist`
|
||||
|
||||
### `getPlaylistVideos`
|
||||
|
||||
## Interfaces
|
||||
|
||||
### `ThumbnailFull`
|
||||
|
||||
### `SongDetailed`
|
||||
|
||||
### `SongFull`
|
||||
|
||||
### `VideoDetailed`
|
||||
|
||||
### `VideoFull`
|
||||
|
||||
### `ArtistBasic`
|
||||
|
||||
### `ArtistDetailed`
|
||||
|
||||
### `ArtistFull`
|
||||
|
||||
### `AlbumBasic`
|
||||
|
||||
### `AlbumDetailed`
|
||||
|
||||
### `AlbumFull`
|
||||
|
||||
### `PlaylistFull`
|
||||
|
|
@ -23,4 +23,4 @@ type SearchResult =
|
|||
|
||||
## Usages
|
||||
|
||||
[YTMusic#search](../ytmusic-methods/search.html)
|
||||
[YTMusic#search](../ytmusic/search.html)
|
||||
|
|
|
|||
Loading…
Reference in New Issue