UNPKG

1.38 kBMarkdownView Raw
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## Get started
21
22```shell
23npm install node-youtube-music
24```
25
26or
27
28```shell
29yarn add node-youtube-music
30```
31
32## How to use
33
34```ts
35import * as ytMusic from 'node-youtube-music';
36
37const musics = await ytMusic.searchMusics('Never gonna give you up');
38
39const suggestions = ytMusic.getSuggestions(musics[0].youtubeId);
40```
41
42## Looking for contributors 👇
43
44- [ ] Search
45 - [x] Musics
46 - [x] Playlists
47 - [x] Albums
48 - [ ] Artists
49- [x] List musics from playlist
50- [x] List musics from album
51- [x] Suggestions from music ID
52- [ ] Playlist management (create, push, remove)
53- [ ] Library management