@stef-0012/synclyrics-react v1.0.0

@stef-0012/synclyrics-react (SyncLyrics)

This package is a conversion to npm of Stef-00012/SyncLyrics that doesn't use node specific modules so it's usable in apps such as React Native.

SyncLyrics allows you to get the synced lyrics of any song avaible on Musixmatch, LrcLib.net or Netease.

Installation: npm i @stef-0012/synclyrics-react.

Usage

const { SyncLyrics } = require("@stef-0012/synclyrics-react");

let mxmToken; // This is just for the custom save/get functions example

const LyricsManager = new SyncLyrics({
    /* Each of those options is optional */
    logLevel: 'none', // One of "none" | "info" | "warn" | "error" | "debug"
    instrumentalLyricsIndicator: "", // Any string
    sources: ["musixmatch", "lrclib", "netease"], // An array with atleast one of those sources
    saveMusixmatchToken: (tokenData) => { // Function to save the Musixmatch token
        mxmToken = tokenData;
    },
    getMusixmatchToken: () => { // Function to save the Musixmatch token
        return mxmToken;
    },
})

LyricsManager.getLyrics({
    /* Each of those options is optional but atleast one is required */
    track: "the old me", // Song name
    artist: "Henry Moodie", // Song artist
    album: "good old days", // Song album
    length: 175000, // Song duration, in ms
}).then(data => {
    console.log(data.lyrics) // LRC format
    console.log(data.parse()) // Array of objects with time as seconds and text of each line
})

When no lyrics are avaible, they are null.