diff --git a/README.md b/README.md index c2dc6f3..a1f3783 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 -#### `getSong` - -This function takes in the following parameters - -| Name | Data Type | Description | -| :------ | :-------- | :---------- | -| videoId | `string` | Video ID | - -The function returns a `Promise<`[SongFull](#SongFull)`>` which is the information about the song - -```ts -ytmusic.getSong("v7bnOxV4jAc").then(song => { - console.log(song) -}) -``` - -#### `getVideo` - -This function takes in the following parameters - -| Name | Data Type | Description | -| :------ | :-------- | :---------- | -| videoId | `string` | Video ID | - -The function returns a `Promise<`[VideoFull](#VideoFull)`>` which is the information about the video - -```ts -ytmusic.getVideo("v7bnOxV4jAc").then(video => { - console.log(video) -}) -``` - -#### `getArtist` - -This function takes in the following parameters - -| Name | Data Type | Description | -| :------- | :-------- | :---------- | -| artistId | `string` | Artist ID | - -The function returns a `Promise<`[ArtistFull](#ArtistFull)`>` which is the information about the artist - -```ts -ytmusic.getArtist("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artist => { - console.log(artist) -}) -``` - #### `getArtistSongs` This function takes in the following parameters @@ -101,38 +53,6 @@ ytmusic.getArtistAlbums("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistAlbums => { }) ``` -#### `getAlbum` - -This function takes in the following parameters - -| Name | Data Type | Description | -| :------ | :-------- | :---------- | -| albumId | `string` | Album ID | - -The function returns a `Promise<`[AlbumFull](#AlbumFull)`>` which is the information about the album - -```ts -ytmusic.getAlbum("MPREb_iG5q5DIdhdA").then(album => { - console.log(album) -}) -``` - -#### `getPlaylist` - -This function takes in the following parameters - -| Name | Data Type | Description | -| :--------- | :-------- | :---------- | -| playlistId | `string` | Playlist ID | - -The function returns a `Promise<`[PlaylistFull](#PlaylistFull)`>` which is the information about the playlist (without the videos) - -```ts -ytmusic.getPlaylist("OLAK5uy_nRb467jR73IXKybwzw22_rTYIJ808x4Yc").then(playlist => { - console.log(playlist) -}) -``` - #### `getPlaylistVideos` This function takes in the following parameters diff --git a/docs/guides/usage/getAlbum.md b/docs/guides/usage/getAlbum.md index e69de29..7b41a94 100644 --- a/docs/guides/usage/getAlbum.md +++ b/docs/guides/usage/getAlbum.md @@ -0,0 +1,11 @@ +# Getting an album + +`getAlbum()` will fetch you information about a specific album by it's ID. + +```ts +ytmusic.getAlbum("MPREb_iG5q5DIdhdA").then(album => { + console.log(album) +}) +``` + +See the [reference](../../references/ytmusic-methods/getAlbum.html) for more information. diff --git a/docs/guides/usage/getArtist.md b/docs/guides/usage/getArtist.md index e69de29..34c905b 100644 --- a/docs/guides/usage/getArtist.md +++ b/docs/guides/usage/getArtist.md @@ -0,0 +1,11 @@ +# Getting an artist + +`getArtist()` will fetch you information about a specific artist by it's ID. + +```ts +ytmusic.getArtist("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artist => { + console.log(artist) +}) +``` + +See the [reference](../../references/ytmusic-methods/getArtist.html) for more information. diff --git a/docs/guides/usage/getPlaylist.md b/docs/guides/usage/getPlaylist.md index e69de29..d079ff8 100644 --- a/docs/guides/usage/getPlaylist.md +++ b/docs/guides/usage/getPlaylist.md @@ -0,0 +1,11 @@ +# Getting a playlist + +`getPlaylist()` will fetch you information about a specific playlist by it's ID. + +```ts +ytmusic.getPlaylist("OLAK5uy_nRb467jR73IXKybwzw22_rTYIJ808x4Yc").then(playlist => { + console.log(playlist) +}) +``` + +See the [reference](../../references/ytmusic-methods/getPlaylist.html) for more information. diff --git a/docs/guides/usage/getSong.md b/docs/guides/usage/getSong.md index e69de29..0ec2fec 100644 --- a/docs/guides/usage/getSong.md +++ b/docs/guides/usage/getSong.md @@ -0,0 +1,11 @@ +# Getting a song + +`getSong()` will fetch you information about a specific song by it's ID. + +```ts +ytmusic.getSong("v7bnOxV4jAc").then(song => { + console.log(song) +}) +``` + +See the [reference](../../references/ytmusic-methods/getSong.html) for more information. diff --git a/docs/guides/usage/getVideo.md b/docs/guides/usage/getVideo.md index e69de29..31a00c7 100644 --- a/docs/guides/usage/getVideo.md +++ b/docs/guides/usage/getVideo.md @@ -0,0 +1,11 @@ +# Getting a video + +`getVideo()` will fetch you information about a specific video by it's ID. + +```ts +ytmusic.getVideo("v7bnOxV4jAc").then(video => { + console.log(video) +}) +``` + +See the [reference](../../references/ytmusic-methods/getVideo.html) for more information. diff --git a/docs/references/ytmusic-methods/getAlbum.md b/docs/references/ytmusic-methods/getAlbum.md index e69de29..6a37913 100644 --- a/docs/references/ytmusic-methods/getAlbum.md +++ b/docs/references/ytmusic-methods/getAlbum.md @@ -0,0 +1,19 @@ +# getAlbum + +See the [guide](../../guides/usage/getAlbum.html) for information on how to use this. + +## Properties + +| Name | Data Type | Description | +| :-------- | :-------- | :---------- | +| `albumId` | `string` | Album ID | + +## Returns + +`Promise<`[AlbumFull](../interfaces/AlbumFull.html)`>` + +## TypeScript Source Code + +```ts +public async getAlbum(albumId: string): Promise +``` diff --git a/docs/references/ytmusic-methods/getArtist.md b/docs/references/ytmusic-methods/getArtist.md index e69de29..7639772 100644 --- a/docs/references/ytmusic-methods/getArtist.md +++ b/docs/references/ytmusic-methods/getArtist.md @@ -0,0 +1,19 @@ +# getArtist + +See the [guide](../../guides/usage/getArtist.html) for information on how to use this. + +## Properties + +| Name | Data Type | Description | +| :--------- | :-------- | :---------- | +| `artistId` | `string` | Artist ID | + +## Returns + +`Promise<`[ArtistFull](../interfaces/ArtistFull.html)`>` + +## TypeScript Source Code + +```ts +public async getArtist(artistId: string): Promise +``` diff --git a/docs/references/ytmusic-methods/getPlaylist.md b/docs/references/ytmusic-methods/getPlaylist.md index e69de29..5b271bf 100644 --- a/docs/references/ytmusic-methods/getPlaylist.md +++ b/docs/references/ytmusic-methods/getPlaylist.md @@ -0,0 +1,19 @@ +# getPlaylist + +See the [guide](../../guides/usage/getPlaylist.html) for information on how to use this. + +## Properties + +| Name | Data Type | Description | +| :----------- | :-------- | :---------- | +| `playlistId` | `string` | Playlist ID | + +## Returns + +`Promise<`[PlaylistFull](../interfaces/PlaylistFull.html)`>` + +## TypeScript Source Code + +```ts +public async getPlaylist(playlistId: string): Promise +``` diff --git a/docs/references/ytmusic-methods/getSong.md b/docs/references/ytmusic-methods/getSong.md index e69de29..f7d3c1a 100644 --- a/docs/references/ytmusic-methods/getSong.md +++ b/docs/references/ytmusic-methods/getSong.md @@ -0,0 +1,19 @@ +# getSong + +See the [guide](../../guides/usage/getSong.html) for information on how to use this. + +## Properties + +| Name | Data Type | Description | +| :-------- | :-------- | :---------- | +| `videoId` | `string` | Video ID | + +## Returns + +`Promise<`[SongFull](../interfaces/SongFull.html)`>` + +## TypeScript Source Code + +```ts +public async getSong(videoId: string): Promise +``` diff --git a/docs/references/ytmusic-methods/getVideo.md b/docs/references/ytmusic-methods/getVideo.md index e69de29..20e4fb2 100644 --- a/docs/references/ytmusic-methods/getVideo.md +++ b/docs/references/ytmusic-methods/getVideo.md @@ -0,0 +1,19 @@ +# getVideo + +See the [guide](../../guides/usage/getVideo.html) for information on how to use this. + +## Properties + +| Name | Data Type | Description | +| :-------- | :-------- | :---------- | +| `videoId` | `string` | Video ID | + +## Returns + +`Promise<`[VideoFull](../interfaces/VideoFull.html)`>` + +## TypeScript Source Code + +```ts +public async getVideo(videoId: string): Promise +```