🚨 fix spelling lint errors
This commit is contained in:
parent
149fc48a00
commit
c4c670f893
|
|
@ -2,9 +2,9 @@
|
||||||
|
|
||||||
    
|
    
|
||||||
|
|
||||||
YouTube Music API (Unofficial) is a YouTube Music data scraper. It comes with TypeScript support API for return types. The NPM Package can be found [here](https://npmjs.com/package/ytmusic-api)
|
YouTube Music API (Unofficial) is a YouTube Music data scraper. It comes with TypeScript support API for return types. The NPM package can be found [here](https://npmjs.com/package/ytmusic-api)
|
||||||
|
|
||||||
**Full Documentation is available [here](http://ytmusic-api.zectan.com).**
|
**Full documentation is available [here](http://ytmusic-api.zectan.com).**
|
||||||
|
|
||||||
## Motivation
|
## Motivation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
YTMusic provides you many ways of fetching data from YouTube Music<br />
|
YTMusic provides you with many ways of fetching data from YouTube Music<br />
|
||||||
To leverage all the functions, we will need to create an instance of the class `YTMusic`.
|
To leverage all the functions, we will need to create an instance of the class `YTMusic`.
|
||||||
Then, call the `initialize()` to initialize the API before using the API anywhere
|
Then, call the `initialize()` to initialize the API before using the API anywhere
|
||||||
|
|
||||||
|
|
@ -14,6 +14,6 @@ ytmusic.initialize().then(() => {
|
||||||
In an async context, you can initialize the API in one line
|
In an async context, you can initialize the API in one line
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
const ytmusic = await new YTMusic().initalize()
|
const ytmusic = await new YTMusic().initialize()
|
||||||
// Use API here
|
// Use API here
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Getting an album
|
# Getting an album
|
||||||
|
|
||||||
`getAlbum()` will fetch you information about a specific album by it's ID.
|
`getAlbum()` will fetch you information about a specific album by its ID.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
ytmusic.getAlbum("MPREb_iG5q5DIdhdA").then(album => {
|
ytmusic.getAlbum("MPREb_iG5q5DIdhdA").then(album => {
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Getting an artist
|
# Getting an artist
|
||||||
|
|
||||||
`getArtist()` will fetch you information about a specific artist by it's ID.
|
`getArtist()` will fetch you information about a specific artist by its ID.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
ytmusic.getArtist("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artist => {
|
ytmusic.getArtist("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artist => {
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Getting an artist's albums
|
# Getting an artist's albums
|
||||||
|
|
||||||
`getArtistAlbums()` will fetch you information about a specific artist's albums by it's ID.
|
`getArtistAlbums()` will fetch you information about a specific artist's albums by its ID.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
ytmusic.getArtistAlbums("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistAlbums => {
|
ytmusic.getArtistAlbums("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistAlbums => {
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Getting an artist's songs
|
# Getting an artist's songs
|
||||||
|
|
||||||
`getArtistSongs()` will fetch you information about a specific artist's songs by it's ID.
|
`getArtistSongs()` will fetch you information about a specific artist's songs by its ID.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
ytmusic.getArtistSongs("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistSongs => {
|
ytmusic.getArtistSongs("UCTUR0sVEkD8T5MlSHqgaI_Q").then(artistSongs => {
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Getting a playlist
|
# Getting a playlist
|
||||||
|
|
||||||
`getPlaylist()` will fetch you information about a specific playlist by it's ID.
|
`getPlaylist()` will fetch you information about a specific playlist by its ID.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
ytmusic.getPlaylist("OLAK5uy_nRb467jR73IXKybwzw22_rTYIJ808x4Yc").then(playlist => {
|
ytmusic.getPlaylist("OLAK5uy_nRb467jR73IXKybwzw22_rTYIJ808x4Yc").then(playlist => {
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Getting an playlist's videos
|
# Getting a playlist's videos
|
||||||
|
|
||||||
`getPlaylistVideos()` will fetch you information about a specific playlist's videos by it's ID.
|
`getPlaylistVideos()` will fetch you information about a specific playlist's videos by its ID.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
ytmusic.getPlaylistVideos("OLAK5uy_nRb467jR73IXKybwzw22_rTYIJ808x4Yc").then(playlistVideos => {
|
ytmusic.getPlaylistVideos("OLAK5uy_nRb467jR73IXKybwzw22_rTYIJ808x4Yc").then(playlistVideos => {
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Getting a song
|
# Getting a song
|
||||||
|
|
||||||
`getSong()` will fetch you information about a specific song by it's ID.
|
`getSong()` will fetch you information about a specific song by its ID.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
ytmusic.getSong("v7bnOxV4jAc").then(song => {
|
ytmusic.getSong("v7bnOxV4jAc").then(song => {
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Getting a video
|
# Getting a video
|
||||||
|
|
||||||
`getVideo()` will fetch you information about a specific video by it's ID.
|
`getVideo()` will fetch you information about a specific video by its ID.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
ytmusic.getVideo("v7bnOxV4jAc").then(video => {
|
ytmusic.getVideo("v7bnOxV4jAc").then(video => {
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue