Class Supplement

Supplementary information about a track (lyrics, videos, radio availability).

Hierarchy (View Summary)

YandexMusicModel
- Supplement

Index

Constructors

Properties

client? description? id? lyrics? radioIsAvailable? videos?

Methods

deJson requireClient

Constructors

constructor

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

description?: string

Description.

`Optional`id

id?: number

Supplement id.

`Optional`lyrics

lyrics?: Lyrics

Embedded lyrics.

`Optional`radioIsAvailable

radioIsAvailable?: boolean

Whether a radio is available for the track.

`Optional`videos

videos?: VideoSupplement[]

Associated videos.

Methods

`Static`deJson

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

`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