💫 Features

- TypeScript Support: llyrics is written in TypeScript, providing type safety and ease of use. Thanks to RemyK for Typescript rewrite ❤.
- Support for Different Sources: You can search for lyrics from YouTube, Musixmatch, or by specifying the desired source(s) in the search options.
- Auto Search: If a search fails on the first specified search engine, llyrics automatically retries the search on another available search engine for a better lyrics result.
- Easy to Use: You can quickly search for song lyrics by providing the song title and, optionally, the artist name.

🪓 Installation

``sh
$ npm install llyrics
$ yarn add llyrics
`

💾 Example

`js
const { find, isNotFoundResponse } = require('llyrics');

client.on(Events.InteractionCreate, async (interaction) => {
if (!interaction.isChatInputCommand()) return;

const response = await find({
song: 'Bohemian Rhapsody',
engine: 'youtube',
forceSearch: true,
});

if (interaction.commandName === 'lyrics') {
if (response && !isNotFoundResponse(response)) {
await interaction.reply({ content: response.lyrics, ephemeral: true });
}
}
});

client.login('token');
`

🔧 Usage

Function parameters

`js
{
song: string, // The title of the song
artist?: string, // Optional: Use this for more accurate lyrics results on the Musixmatch endpoint
engine?: 'musixmatch' | 'youtube', // Specify the desired search engine: 'musixmatch', or 'youtube'
forceSearch?: boolean // Optional: If true and the search fails on the first specified search engine, llyrics automatically retries the search on another available search engine
}

`

Response format

`js
{
artist: string, // Artist's name
title: string, // Song title
id: number, // Track ID
engine: string, // Search engine used
artworkURL: string, // Artwork URL
lyrics: string, // Song lyrics
status: string, // Response status code
}
``