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

lyrics-search

v1.0.0

Published

A Node.js package to search for song lyrics by artist and title.

Downloads

71

Readme

🎶 Lyrics Search

lyrics-search is a simple Node.js package that allows you to fetch song lyrics based on the artist and song title using the Lyrics.ovh API. It's easy to use, lightweight, and does not require any API key.

⭐ Features

  • Fetch song lyrics by providing the artist name and song title.
  • No need for API keys or authentication.
  • Lightweight and fast using Axios for HTTP requests.
  • Simple and clean output, returning just the lyrics text.

🧰 Installation

Install the package via npm:

npm install lyrics-search

🛠️ Usage

Using lyrics-search is straightforward. You can easily search for lyrics by providing the artist name and song title. Below is an example:

const LyricsAuth = require('lyrics-search');

const lyricsAuth = new LyricsAuth();

(async () => {
    const artist = 'Adele';
    const title = 'Hello';
  
    try {
        const lyrics = await lyricsAuth.searchLyrics(artist, title);
        console.log(lyrics); // Display only the lyrics
    } catch (error) {
        console.error(error.message);
    }
})();

📡 API

searchLyrics(artist, title)

Fetches the lyrics for the specified song.

  • artist (string) - Name of the artist.
  • title (string) - Title of the song.

Returns: The full text of the lyrics if found.

⚙️ Error Handling

If the lyrics are not found or an error occurs, the package throws an error with a descriptive message:

try {
    const lyrics = await lyricsAuth.searchLyrics('Unknown Artist', 'Unknown Song');
} catch (error) {
    console.error(error.message); // Output: Lyrics not found
}

👋 Contributing

Feel free to open issues or submit pull requests for any improvements or bug fixes. Contributions are always welcome!.

🌐 License

This project is licensed under the MIT License - see the LICENSE file for details.

🚀 Credit

This project utilizes the Lyrics.ovh API for fetching lyrics. Special thanks to their service for making this possible.

🤝 Contributors

  • Michxoo - Creator and primary developer.