Optionaloptions: ClientOptionsAn optional object containing Client Options
url: The base URL, e.g. you can set up a custom url that uses another lrclib.net instancekey: The token used to publish lyrics to the api. click here for more infoFinds lyrics for a given track using the API at https://lrclib.net/api/get.
Example Usage:
const lyrics = await findLyrics({ track_name: "The Chain", artist_name: "Fleetwood Mac" });
An object containing query parameters:
id: The unique identifier of the track (conditional).track_name: The name of the track (conditional).artist_name: The artist's name (conditional).album_name: The album's name (optional).duration: The song duration in milliseconds (optional).Optionaloptions: RequestInitA promise that resolves to a FindLyricsResponse object containing the track's lyrics.
Retrieves synchronized (timed) lyrics for a given track.
Example Usage:
const syncedLyrics = await getSynced({ track_name: "The Chain", artist_name: "Fleetwood Mac" });
An object containing query parameters:
id: The unique identifier of the track (conditional).track_name: The name of the track (conditional).artist_name: The artist's name (conditional).album_name: The album's name (optional).duration: The song duration in milliseconds (optional).A promise that resolves to an array of LyricLine[] objects
containing synchronized lyrics or null if no lyrics are found.
Retrieves unsynchronized (plain) lyrics for a given track.
Example Usage:
const unsyncedLyrics = await getUnsynced({ track_name: "The Chain", artist_name: "Fleetwood Mac" });
An object containing query parameters:
id: The unique identifier of the track (conditional).track_name: The name of the track (conditional).artist_name: The artist's name (conditional).album_name: The album's name (optional).duration: The song duration in milliseconds (optional).A promise that resolves to an array of LyricLine[] objects
containing unsynchronized lyrics or null if no lyrics are found.
Sends a request to the lyrics search API at https://lrclib.net/api/search.
Example Usage:
const search = await searchLyrics({ query: "The Chain" });
An object containing search parameters:
query: The search term (conditional | e.g., song title or lyrics fragment).track_name: The name of the track (conditional).artist_name: The artist's name (optional).duration: The song duration in milliseconds (optional).Optionaloptions: RequestInitA promise that resolves to an array of FindLyricsResponse[].
Creates a request client to api
Example Usage;
@notigorwastaken: I'm still working on it.