Class Lyrics

Track lyrics embedded in the supplement.

Deprecated

Fetching lyrics via the supplement is legacy; prefer Client.tracksLyrics.

Hierarchy (View Summary)

YandexMusicModel
- Lyrics

Index

Constructors

Properties

client? fullLyrics? hasRights? id? lyrics? showTranslation? textLanguage? url?

Methods

deJson requireClient

Constructors

constructor

new Lyrics(client?: Client): Lyrics
Parameters
- Optionalclient: Client
  The owning client, stored for later convenience calls.
Returns Lyrics
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`fullLyrics

fullLyrics?: string

Full lyrics.

`Optional`hasRights

hasRights?: boolean

Whether the lyrics are rights-cleared.

`Optional`id

id?: number

Lyric id.

`Optional`lyrics

lyrics?: string

Lyrics, possibly truncated.

`Optional`showTranslation

showTranslation?: boolean

Whether a translation is shown.

`Optional`textLanguage

textLanguage?: string

Lyrics language.

`Optional`url

url?: string

Source URL.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): Lyrics | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns Lyrics | null
See
Lyrics
- Defined in src/models/supplement.ts:33

`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