Private_fetchingWhetever it is fetching a song currently
-Private_trackUsed for the logging within the different functions and to fetch the track's data from the cache if avaible
-Any method that can store data and has .set(), .get() and .has() functions
-Function used to fetch the Musixmatch token (required to fetch the lyrics data from Musixmatch)
-The character to use for instrumental lyrics (more than 3 seconds of music without any voice)
-The level of the logging
-PrivatelyricsThe fetched lyrics, used for the .parse() method in the LineSyncedLyricsData
-Function used to save the Musixmatch token (required to fetch the lyrics data from Musixmatch)
-Array of sources to use, in the order they have to be fetched
-Private_fetchFetches the line synced lyrics of the song from Musixmatch, only if the search result specifies the song has line synced lyrics
+Private_fetchingWhetever it is fetching a song currently
+Private_trackUsed for the logging within the different functions and to fetch the track's data from the cache if avaible
+Any method that can store data and has .set(), .get() and .has() functions
+Function used to fetch the Musixmatch token (required to fetch the lyrics data from Musixmatch)
+The character to use for instrumental lyrics (more than 3 seconds of music without any voice)
+The level of the logging
+PrivatelyricsThe fetched lyrics, used for the .parse() method in the LineSyncedLyricsData
+Function used to save the Musixmatch token (required to fetch the lyrics data from Musixmatch)
+Array of sources to use, in the order they have to be fetched
+Private_fetchFetches the line synced lyrics of the song from Musixmatch, only if the search result specifies the song has line synced lyrics
The Musixmatch's token data
The Musixmatch track's commontrack_id
The Track's Lyrics if avaible
-Private_fetchFetches the song's lyrics based on the search results
+Private_fetchFetches the song's lyrics based on the search results
The Musixmatch's token data
The Musixmatch track's track_id
@@ -61,91 +61,91 @@Whetever the search result specifies the song has word synced lyrics
The type of lyrics to fetch
Plain, line synced and word synced lyrics when avaible
-Private_fetchFetches the line synced lyrics from Netease
+Private_fetchPrivate_fetchFetches the plain lyrics of the song from Musixmatch, only if the search result specifies the song has plain lyrics
+Private_fetchFetches the plain lyrics of the song from Musixmatch, only if the search result specifies the song has plain lyrics
The Musixmatch's token data
The Musixmatch track's commontrack_id
The Track's Lyrics if avaible
-Private_fetchFetches the line word lyrics of the song from Musixmatch, only if the search result specifies the song has word synced lyrics
+Private_fetchFetches the line word lyrics of the song from Musixmatch, only if the search result specifies the song has word synced lyrics
The Musixmatch's token data
The Musixmatch track's track_id
The Track's Lyrics if avaible
-Private_getFetches the lyrics from the specified sources
+Private_getFetches the lyrics from the specified sources
The type of lyrics to fetch
The lyrics fetched the avaible sources
-Private_parseRemoves useless metadata returned by Netease
+Private_parsePrivate_searchSearchs the Musixmatch catalog with the data provided in the metadata
+Private_searchSearchs the Musixmatch catalog with the data provided in the metadata
The Musixmatch's token data
If found, the Musixmatch's commontrack_id, track_id and whetever the track has lyrics, line synced lyrics or word synced lyrics
-Private_searchSearchs the Netease catalog with the data provided in the metadata
+Private_searchIf found, the Netease track's ID
-PrivatedebugLogs the text with a purple "DEBUG: " prefix
+PrivatedebugPrivateerrorLogs the text with a red "ERROR: " prefix
+PrivateerrorPrivatefetchFetches the plain and line synced lyrics from the lrclib.net's catalogue
+PrivatefetchFetches the plain and line synced lyrics from the lrclib.net's catalogue
The type of lyrics to fetch
Plain and line synced lyrics from lrclib.net when avaible
-PrivatefetchFetches the plain, line synced and word synced lyrics from the Musixmatch's catalogue
+PrivatefetchFetches the plain, line synced and word synced lyrics from the Musixmatch's catalogue
The type of lyrics to fetch
Plain, line synced and word synced lyrics from Musixmatch when avaible
-PrivatefetchFetches the line synced lyrics from the Netease's catalogue
+PrivatefetchFetches the line synced lyrics from the Netease's catalogue
The type of lyrics to fetch
Line synced lyrics from Netease when avaible
-Fetches from the cache or the sources, the song based on the track's metadata or ID
+OptionalskipCache: booleanWhetever skip cache check or not
The lyrics of the song when avaible
PrivategetGets the Musixmatch's usertoken if not returned by the getMusixmatchToken() method
+PrivategetGets the Musixmatch's usertoken if not returned by the getMusixmatchToken() method
Optionalcookies: stringMusixmatch's HTTP request cookies
PrivateinfoParses LRC formatted lyrics into an array of text and time
+The lyrics as an array of time and text
-Updates or resets the cache
+Updates or resets the cache
OptionalnewCache: Cache<undefined | null | string, undefined | null | CacheLyrics>The new cache
Updated SyncLyrics instance
-Updates or removes the getMusixmatchToken function
+Updates or removes the getMusixmatchToken function
Updated SyncLyrics instance
-Updates or resets the instrumental lyrics indicator (character used when there are more than 3 seconds of music without lyrics)
+Updates or resets the instrumental lyrics indicator (character used when there are more than 3 seconds of music without lyrics)
OptionalnewInstrumentalLyricsIndicator: stringThe new instrumentalLyricsIndicator
Updated SyncLyrics instance
-Updates or resets the log level
+Updates or resets the log level
Updated SyncLyrics instance
-Updates or removes the saveMusixmatchToken function
+Updates or removes the saveMusixmatchToken function
OptionalsaveMusixmatchToken: ((tokenData: TokenData) => void | Promise<void>)The new saveMusixmatchToken function
Updated SyncLyrics instance
-Updates or resets the sources
+Updates or resets the sources
Updated SyncLyrics instance
-PrivatewarnParses special characters (Usually returned by Netease) into common characters
+Parses special characters (Usually returned by Netease) into common characters
The string to parse
Parsed string with common characters
-SyncLyrics allows you to get the plain, line synced and word synced lyrics of any song avaible on Musixmatch, LrcLib.net or Netease.
+SyncLyrics allows you to get the plain, line synced and word synced lyrics of any song avaible on Musixmatch, LrcLib.net or Netease.
Installation: npm i @stef-0012/synclyrics.
const { SyncLyrics } = require("@stef-0012/synclyrics");
let mxmToken; // This is just for the custom save/get functions example
const LyricsManager = new SyncLyrics({
/* Each of those options is optional */
cache: new Map(), // Anything that can store data and has a .set(K, V), .get(K) and .has(K) values
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) => { // A custom function to save the Musixmatch token, otherwise it'll skip Musixmatch fetch
mxmToken = tokenData;
},
getMusixmatchToken: () => { // A custom function to save the Musixmatch token, otherwise it'll skip Musixmatch fetch
return mxmToken;
},
})
LyricsManager.getLyrics({
/* Each of those options is optional but atleast one is required excluded length */
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)
}) // Array of objects with time as seconds and text of each line
// or
const trackId = LyricsManager.getTrackId({
/* Each of those options is optional but atleast one is required excluded length */
track: "the old me", // Song name
artist: "Henry Moodie", // Song artist
album: "good old days", // Song album
length: 175000, // Song duration, in ms
})
LyricsManager.getLyrics({
trackId: trackId
}).then(data => {
console.log(data)
})
[
{
time: 0.14,
text: 'Fifth of November, when I walked you home'
},
{
time: 8.06,
text: `That's when I nearly said it, but then said, "Forget it," and froze`
},
{
time: 15.55,
text: "Do you remember? You probably don't"
},
{
time: 23.44,
text: "'Cause the sparks in the sky took a hold of your eyes while we spoke"
},
// ..... (rest of the lyrics)
]
Any method that can store data and has .set(), .get() and .has() functions
-Any method that can store data and has .set(), .get() and .has() functions
+Function used to get the song's data to the cache
-Function to check if the cache has the song's data
-Function used to set the song's data to the cache
-Function to check if the cache has the song's data
+Function used to set the song's data to the cache
+PrivateLyrics source
+PrivatePrivateOptionalcacheAny method that can store data and has .set(), .get() and .has() functions
-OptionalgetFunction used to fetch the Musixmatch token (required to fetch the lyrics data from Musixmatch)
-OptionalinstrumentalThe character to use for instrumental lyrics (more than 3 seconds of music without any voice)
-OptionallogThe level of the logging
-OptionalsaveFunction used to save the Musixmatch token (required to fetch the lyrics data from Musixmatch)
-OptionalsourcesArray of sources to use, in the order they have to be fetched
-OptionalgetFunction used to fetch the Musixmatch token (required to fetch the lyrics data from Musixmatch)
+OptionalinstrumentalThe character to use for instrumental lyrics (more than 3 seconds of music without any voice)
+OptionallogThe level of the logging
+OptionalsaveFunction used to save the Musixmatch token (required to fetch the lyrics data from Musixmatch)
+OptionalsourcesArray of sources to use, in the order they have to be fetched
+Line synced lyrics in the LRC format
-Function to parse the returned lyrics into FormattedLyric
-Lyrics source
-Function to parse the returned lyrics into FormattedLyric
+Lyrics source
+PrivatePrivateLine synced lyrics if avaible
-Plain lyrics if avaible
-Always null as lrclib.net does not support word synced lyrics
-Plain lyrics if avaible
+Always null as lrclib.net does not support word synced lyrics
+Song's album
-Song's artist(s)
-Whetever the song data was retrieved from the cache rather than the APIs
-Object with track's avaible lyrics
-Song's name
-Fetched track's ID
-Song's artist(s)
+Whetever the song data was retrieved from the cache rather than the APIs
+Object with track's avaible lyrics
+Song's name
+Fetched track's ID
+Song's metadata
-Song's metadata
+OptionalalbumSong's album
-OptionalartistSong's artist(s)
-OptionallengthSong's duration (in ms)
-OptionallyricsAn array of lyric types to fetch
-OptionaltrackSong's name
-OptionaltrackSong's ID (returned by getTrackId)
-OptionalartistSong's artist(s)
+OptionallengthSong's duration (in ms)
+OptionallyricsAn array of lyric types to fetch
+OptionaltrackSong's name
+OptionaltrackSong's ID (returned by getTrackId)
+PrivatePrivateOptionalplainPlain lyrics if avaible
+Musixmatch
+OptionalwordLine synced lyrics if avaible
+PrivatePrivateTrack's plain lyrics
+Track's word synced lyrics
+PrivatePrivateMusixmatch's commontrack_id
-Whetever the Musixmatch's catalogue has the song's line synced lyrics
-Whetever the Musixmatch's catalogue has the song's plain lyrics
-Whetever the Musixmatch's catalogue has the song's word synced lyrics
-Musixmatch's track_id
-Whetever the Musixmatch's catalogue has the song's line synced lyrics
+Whetever the Musixmatch's catalogue has the song's plain lyrics
+Whetever the Musixmatch's catalogue has the song's word synced lyrics
+Musixmatch's track_id
+PrivatePrivateAlways null as Netease does not support word synced lyrics
+Netease
+Always null as Netease does not support word synced lyrics
+Lyrics source
+PrivateMusixmatch token data
-PrivateMusixmatch token data
+Cookies used for the Musixmatch's API request
-When the Musixmatch's usertoken expires
-Musixmatch's usertoken
-When the Musixmatch's usertoken expires
+Musixmatch's usertoken
+The lyric complete text
+When the lyric's line starts
+The lyric synced by characters
+Lyrics source
+When the character timeframe starts
+Avaible sources:
+Avaible sources:
-ConstConstConstConstConstConst
Example
-