provider

package

v0.2.0 Latest Latest Go to latest Published: Jun 23, 2025 License: GPL-3.0 Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mbaraa/danklyrics

Links

Open Source Insights

Documentation ¶

Index ¶

type Name
type SearchParams
type Service

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Name ¶

type Name string

Name represents lyrics finding providers to choose from when doing a lyrics search.

const (
	// Dank pass this to [GetSongLyrics] to use DankLyrics as a lyrics provider.
	Dank Name = "dank"
	// Genius pass this to [GetSongLyrics] to use Genius as a lyrics provider.
	Genius Name = "genius"
	// LyricFind pass this to [GetSongLyrics] to use LyricFind as a lyrics provider.
	LyricFind Name = "lrc"
)

type SearchParams ¶

type SearchParams struct {
	SongName   string
	ArtistName string
	AlbumName  string
}

SearchParams holds the search criteria to find a song from a provider.

type Service ¶

type Service interface {
	// GetSongLyrics searches for a song's lyrics using the given search params.
	GetSongLyrics(s SearchParams) (models.Lyrics, error)
}

Service fetches lyrics for the given song in the search params.

Source Files ¶

View all Source files

provider.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL