diff --git a/README.md b/README.md index a1f3783..7b5aab3 100644 --- a/README.md +++ b/README.md @@ -21,54 +21,6 @@ Because of this, I decided to build my own version of a youtube music api with T - Albums - Playlists -#### `getArtistSongs` - -This function takes in the following parameters - -| Name | Data Type | Description | -| :------- | :-------- | :---------- | -| artistId | `string` | Artist ID | - -The function returns a `Promise<`[SongDetailed](#SongDetailed)`[]>` which is the information about all the artist's songs - -```ts -ytmusic.getArtistSongs("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistSongs => { - console.log(artistSongs) -}) -``` - -#### `getArtistAlbums` - -This function takes in the following parameters - -| Name | Data Type | Description | -| :------- | :-------- | :---------- | -| artistId | `string` | Artist ID | - -The function returns a `Promise<`[AlbumDetailed](#AlbumDetailed)`[]>` which is the information about all the artist's albums - -```ts -ytmusic.getArtistAlbums("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistAlbums => { - console.log(artistAlbums) -}) -``` - -#### `getPlaylistVideos` - -This function takes in the following parameters - -| Name | Data Type | Description | -| :--------- | :-------- | :---------- | -| playlistId | `string` | Playlist ID | - -The function returns a `Promise[]>` which is the information about the videos without the view count - -```ts -ytmusic.getPlaylistVideos("OLAK5uy_nRb467jR73IXKybwzw22_rTYIJ808x4Yc").then(playlistVideos => { - console.log(playlistVideos) -}) -``` - ## Credits A lot of the credit should go to [youtube-music-api](https://npmjs.com/package/youtube-music-api). I build this package as a refactored and tested version of youtube-music-api with TypeScript annotations diff --git a/docs/guides/usage/getArtistAlbums.md b/docs/guides/usage/getArtistAlbums.md index e69de29..d207e2b 100644 --- a/docs/guides/usage/getArtistAlbums.md +++ b/docs/guides/usage/getArtistAlbums.md @@ -0,0 +1,11 @@ +# Getting an artist's albums + +`getArtistAlbums()` will fetch you information about a specific artist's albums by it's ID. + +```ts +ytmusic.getArtistAlbums("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistAlbums => { + console.log(artistAlbums) +}) +``` + +See the [reference](../../references/ytmusic-methods/getArtistAlbums.html) for more information. diff --git a/docs/guides/usage/getArtistSongs.md b/docs/guides/usage/getArtistSongs.md index e69de29..79c5e26 100644 --- a/docs/guides/usage/getArtistSongs.md +++ b/docs/guides/usage/getArtistSongs.md @@ -0,0 +1,11 @@ +# Getting an artist's songs + +`getArtistSongs()` will fetch you information about a specific artist's songs by it's ID. + +```ts +ytmusic.getArtistSongs("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistSongs => { + console.log(artistSongs) +}) +``` + +See the [reference](../../references/ytmusic-methods/getArtistSongs.html) for more information. diff --git a/docs/guides/usage/getPlaylistVideos.md b/docs/guides/usage/getPlaylistVideos.md index e69de29..e8bd468 100644 --- a/docs/guides/usage/getPlaylistVideos.md +++ b/docs/guides/usage/getPlaylistVideos.md @@ -0,0 +1,11 @@ +# Getting an playlist's videos + +`getPlaylistVideos()` will fetch you information about a specific playlist's videos by it's ID. + +```ts +ytmusic.getPlaylistVideos("OLAK5uy_nRb467jR73IXKybwzw22_rTYIJ808x4Yc").then(playlistVideos => { + console.log(playlistVideos) +}) +``` + +See the [reference](../../references/ytmusic-methods/getPlaylistVideos.html) for more information. diff --git a/docs/references/ytmusic-methods/getArtistAlbums.md b/docs/references/ytmusic-methods/getArtistAlbums.md index e69de29..7c4d55e 100644 --- a/docs/references/ytmusic-methods/getArtistAlbums.md +++ b/docs/references/ytmusic-methods/getArtistAlbums.md @@ -0,0 +1,19 @@ +# getArtistAlbums + +See the [guide](../../guides/usage/getArtistAlbums.html) for information on how to use this. + +## Properties + +| Name | Data Type | Description | +| :--------- | :-------- | :---------- | +| `artistId` | `string` | Artist ID | + +## Returns + +`Promise<`[AlbumDetailed](../interfaces/AlbumDetailed.html)`[]>` + +## TypeScript Source Code + +```ts +public async getArtistAlbums(artistId: string): Promise +``` diff --git a/docs/references/ytmusic-methods/getArtistSongs.md b/docs/references/ytmusic-methods/getArtistSongs.md index e69de29..d269192 100644 --- a/docs/references/ytmusic-methods/getArtistSongs.md +++ b/docs/references/ytmusic-methods/getArtistSongs.md @@ -0,0 +1,19 @@ +# getArtistSongs + +See the [guide](../../guides/usage/getArtistSongs.html) for information on how to use this. + +## Properties + +| Name | Data Type | Description | +| :--------- | :-------- | :---------- | +| `artistId` | `string` | Artist ID | + +## Returns + +`Promise<`[SongDetailed](../interfaces/SongDetailed.html)`[]>` + +## TypeScript Source Code + +```ts +public async getArtistSongs(artistId: string): Promise +``` diff --git a/docs/references/ytmusic-methods/getPlaylistVideos.md b/docs/references/ytmusic-methods/getPlaylistVideos.md index e69de29..f346746 100644 --- a/docs/references/ytmusic-methods/getPlaylistVideos.md +++ b/docs/references/ytmusic-methods/getPlaylistVideos.md @@ -0,0 +1,19 @@ +# getPlaylistVideos + +See the [guide](../../guides/usage/getPlaylistVideos.html) for information on how to use this. + +## Properties + +| Name | Data Type | Description | +| :----------- | :-------- | :---------- | +| `playlistId` | `string` | Playlist ID | + +## Returns + +`Promise[]>` + +## TypeScript Source Code + +```ts +public async getPlaylistVideos(playlistId: string): Promise[]> +```