| 1 | <p align="center">
|
| 2 | <img width="400" alt="typescript-starter dark logo" src="https://user-images.githubusercontent.com/16015833/103463862-d9ee3200-4d2f-11eb-96d2-e02f5a5c9637.png" style="max-width:100%;">
|
| 3 |
|
| 4 | <h2 align="center">
|
| 5 | Unofficial YouTube Music API for Node.js
|
| 6 | </h2>
|
| 7 |
|
| 8 | <p align="center">
|
| 9 | <a href="https://www.npmjs.com/package/node-youtube-music">
|
| 10 | <img src="https://img.shields.io/npm/v/node-youtube-music.svg" alt="version" />
|
| 11 | </a>
|
| 12 | <a href="https://npmjs.org/package/node-youtube-music">
|
| 13 | <img src="https://img.shields.io/npm/dm/node-youtube-music.svg" alt="downloads" />
|
| 14 | </a>
|
| 15 | <a href="https://packagephobia.now.sh/result?p=node-youtube-music">
|
| 16 | <img src="https://packagephobia.now.sh/badge?p=node-youtube-music" alt="install size" />
|
| 17 | </a>
|
| 18 | </p>
|
| 19 |
|
| 20 | ## Features
|
| 21 |
|
| 22 | - [x] Search
|
| 23 | - [x] Musics
|
| 24 | - [x] Playlists
|
| 25 | - [x] Albums
|
| 26 | - [x] Artists
|
| 27 | - [x] List musics from playlist
|
| 28 | - [x] List musics from album
|
| 29 | - [x] List albums from artist
|
| 30 | - [x] List musics from artist
|
| 31 | - [x] Get suggestions from music
|
| 32 | - [ ] Playlist management (create, push, remove)
|
| 33 | - [ ] Library management
|
| 34 |
|
| 35 | ## Get started
|
| 36 |
|
| 37 | ```shell
|
| 38 | npm install node-youtube-music
|
| 39 | ```
|
| 40 |
|
| 41 | or
|
| 42 |
|
| 43 | ```shell
|
| 44 | yarn add node-youtube-music
|
| 45 | ```
|
| 46 |
|
| 47 | ## How to use
|
| 48 |
|
| 49 | ```ts
|
| 50 | import {
|
| 51 | searchMusics,
|
| 52 | searchAlbums,
|
| 53 | searchPlaylists,
|
| 54 | getSuggestions,
|
| 55 | listMusicsFromAlbum,
|
| 56 | listMusicsFromPlaylist,
|
| 57 | searchArtists,
|
| 58 | getArtist,
|
| 59 | } from 'node-youtube-music';
|
| 60 |
|
| 61 | const musics = await searchMusics('Never gonna give you up');
|
| 62 |
|
| 63 | const albums = await searchAlbums('Human after all');
|
| 64 |
|
| 65 | const playlists = await searchPlaylists('Jazz');
|
| 66 |
|
| 67 | const suggestions = await getSuggestions(musics[0].youtubeId);
|
| 68 |
|
| 69 | const albumSongs = await listMusicsFromAlbum(albums[0].albumId);
|
| 70 |
|
| 71 | const playlistSongs = await listMusicsFromPlaylist(playlists[0].playlistId);
|
| 72 |
|
| 73 | const artists = await searchArtists('Daft Punk');
|
| 74 |
|
| 75 | const artist = await getArtist(artists[0].artistId);
|
| 76 | ```
|