@vookav2/searchmusic
v1.0.6
Published
Accurate search for musics, albums, artists, with related playlists and lyrics.
Downloads
3
Readme
🔍 searchmusic
Accurate search for musics, albums, artists, with related playlists and lyrics.
Features
- Search musics, albums, and artists with auto title correction.
- Get related playlists from music, album, or artist.
- Easily to get lyrics from music
- Title suggestions
Getting Started
Prerequisites
- Node.js v16 or greater
node --version
Installation
- NPM
npm install @vookav2/searchmusic
- Yarn
yarn add @vookav2/searchmusic
Usage
Import functions that you need.
import { searchSong, searchArtist, searchAlbum, search } from '@vookav2/searchmusic'
const response = await searchSong('one more light')
Output
{
playlistId: string,
playlistTitle: string,
isInfinite: boolean,
token: string,
hash: string, // md5(playlistId + playlistTitle)
length: number,
songs: Song[],
}
{
title: string,
lyrics: string,
source: {
name: string,
url: string,
link: string,
},
}
{
search: {
type: string,
query: string,
correctedQuery: string,
},
song: {
id: string,
title: string,
url: string,
hash: string, // md5(id + title)
channel: {
id: string,
name: string,
},
album: {
id: string,
title: string,
},
explicit: boolean,
durationMiliseconds: number,
durationString: string,
thumbnail: string,
selected: boolean,
getLyrics: () => Promise<Lyrics>,
getPlaylist: () => Promise<Playlist>,
}
}
{
search: {
type: string,
query: string,
correctedQuery: string,
},
album: {
id: string,
title: string,
thumbnail: string,
explicit: boolean,
hash: string, // md5(id + title)
channel: {
id: string,
name: string,
},
getPlaylist: () => Promise<Playlist>,
}
}
{
search: {
type: string,
query: string,
correctedQuery: string,
},
artist: {
id: string,
name: string,
url: string,
thumbnail: string,
hash: string, // md5(id + name)
getPlaylist: () => Promise<Playlist>,
}
}
{
search: {
type: 'Song' | 'Album' | 'Channel' | 'Playlist' | 'Unknown',
query: string,
correctedQuery: string,
},
result: Song | Album | Channel | Playlist | undefined
}
Get Playlist From URL
import { getPlaylistFromUrl } from '@vookav2/searchmusic'
// const url = 'https://www.youtube.com/playlist?list={playlistId}'
// const url = 'https://www.youtube.com/channel/{channelId}'
// const url = 'https://www.youtube.com/watch?v={videoId}&list={playlistId}'
const response = await getPlaylistFromUrl(url) // => Playlist
Query suggestion
import { querySuggestion } from '@vookav2/searchmusic'
const query = 'title'
const response = await querySuggestion(query)
/**
{
original: string,
suggestions: string[],
}
*/
Contributing
Contributions, issues and feature requests are welcome. Feel free to check issues page if you want to contribute.
Support
Give a 🌟 star if this project is useful to you.
Disclaimer
This project is not affiliated with, endorsed, or sponsored by YouTube or any of their affiliates or subsidiaries. All trademarks, logos and brand names are the property of their respective owners, and are used only to directly describe the services being provided, as such, any usage of trademarks to refer to such services is considered nominative use.
Should you have any questions or concerns please contact me directly via email.
License
Distributed under the MIT License.