Class TrackLyrics

Lyrics of a track.

Hierarchy (View Summary)

YandexMusicModel
- TrackLyrics

Index

Constructors

Properties

client? downloadUrl? externalLyricId? lyricId? major? writers?

Methods

deJson fetchLyrics requireClient

Constructors

constructor

new TrackLyrics(client?: Client): TrackLyrics
Parameters
- Optionalclient: Client
  The owning client, stored for later convenience calls.
Returns TrackLyrics
Inherited from YandexMusicModel.constructor
- Defined in src/base.ts:177

Properties

`Optional`client

client?: Client

The client that created this model, used by convenience methods.

`Optional`downloadUrl

downloadUrl?: string

URL the raw lyrics text is fetched from.

`Optional`externalLyricId

externalLyricId?: string

External lyric identifier.

`Optional`lyricId

lyricId?: number

Lyric identifier.

`Optional`major

major?: LyricsMajor

Lyrics provider major.

`Optional`writers

writers?: string[]

Writer credits.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): TrackLyrics | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns TrackLyrics | null
See
TrackLyrics
- Defined in src/models/track/extras.ts:323

fetchLyrics

fetchLyrics(): Promise<string>
Fetch the raw lyrics text (plain or LRC, matching the requested format).

Returns Promise<string>
The lyrics text.

Throws
On any transport or API error.
- Defined in src/models/track/extras.ts:340

`Protected`requireClient

requireClient(): Client
Assert that this model carries a client, returning it narrowed to non-null.

Convenience methods that need to call the API use this to fail fast with a clear message instead of a generic "cannot read property of undefined".

Returns Client
The owning Client.

Throws
When the model was created without a client.
Inherited from YandexMusicModel.requireClient
- Defined in src/base.ts:190