Class PlaylistRecommendations

Track recommendations generated for a playlist.

Hierarchy (View Summary)

YandexMusicModel
- PlaylistRecommendations

Index

Constructors

Properties

batchId? client? tracks?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`batchId

batchId?: string

Identifier of the recommendation batch.

`Optional`client

client?: Client

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

`Optional`tracks

tracks?: Track[]

The recommended tracks.

Methods

`Static`deJson

deJson(
raw: JSONValue | undefined,
client?: Client,
): PlaylistRecommendations | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns PlaylistRecommendations | null
See
PlaylistRecommendations
- Defined in src/models/playlist/playlistExtras.ts:23

`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