lyrics-search v1.0.0

🎶 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.