npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@vookav2/searchmusic

v1.0.6

Published

Accurate search for musics, albums, artists, with related playlists and lyrics.

Downloads

16

Readme

🔍 searchmusic

Accurate search for musics, albums, artists, with related playlists and lyrics.

Donate Donate

Tests codecov Codefactor Latest version Monthly downloads

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.

(⬆ back to top)