Class LyricsInfo

Availability of lyrics for a track.

Hierarchy (View Summary)

YandexMusicModel
- LyricsInfo

Index

Constructors

Properties

client? hasAvailableSyncLyrics? hasAvailableTextLyrics?

Methods

deJson requireClient

Constructors

constructor

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

hasAvailableSyncLyrics?: boolean

Whether time-synced (LRC) lyrics are available.

`Optional`hasAvailableTextLyrics

hasAvailableTextLyrics?: boolean

Whether plain-text lyrics are available.

Methods

`Static`deJson

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

`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