Interface: LyricsResult

Defined in: src/song-lyrics/song.ts:7

The LyricsResult interface represents the structure of the response containing details of a song, including the title, artist, URL, and cleaned lyrics. This interface is essential for handling song lyrics data within the Mika Scraper module.

Properties

title

title: string

Defined in: src/song-lyrics/song.ts:8
Represents the title of the song.

artist

artist: string

Defined in: src/song-lyrics/song.ts:9
Represents the name of the artist who performed the song.

lyrics

lyrics: string

Defined in: src/song-lyrics/song.ts:10
Contains the cleaned lyrics of the song, stripped of any unnecessary formatting or metadata.

url

url: string

Defined in: src/song-lyrics/song.ts:11
Provides a URL link to the source where the lyrics can be found or the song is hosted.

Example


const exampleLyricsResult: LyricsResult = {
    title: "Example Song",
    artist: "Example Artist",
    lyrics: "These are the cleaned lyrics of the example song.",
    url: "https://example.com/song"
};