Class GeniusProvider

Provides song data from Genius.com.

export

Hierarchy

BaseProvider
- GeniusProvider

Index

Constructors

constructor

Properties

apiKey

Methods

Constructors

constructor

new GeniusProvider(apiKey?: string): GeniusProvider

Inherited from BaseProvider.constructor
- Defined in providers/GeniusProvider.ts:37
Creates an Genius provider.

The API key is 100% optional and it's only used for searching.

Parameters
- Optional apiKey: string
Returns GeniusProvider

Properties

Private Optional apiKey

apiKey: undefined | string

Methods

Private apiSearch

apiSearch(query: string): Promise<PartialSong[]>

- Defined in providers/GeniusProvider.ts:58
Parameters
- query: string
Returns Promise<PartialSong[]>

lyrics

lyrics(song: PartialSong, firstTime?: boolean): Promise<Song>

Overrides BaseProvider.lyrics
- Defined in providers/GeniusProvider.ts:98
Parameters
- song: PartialSong
- firstTime: boolean = true
Returns Promise<Song>

Private peasantSearch

peasantSearch(query: string): Promise<PartialSong[]>

- Defined in providers/GeniusProvider.ts:74
Parameters
- query: string
Returns Promise<PartialSong[]>

search

search(query: string): Promise<PartialSong[]>

Overrides BaseProvider.search
- Defined in providers/GeniusProvider.ts:50
Parameters
- query: string
Returns Promise<PartialSong[]>

Generated using TypeDoc