Class ArtistEvent

An artist together with surfaced tracks and similar artists inside a feed Event.

Hierarchy (View Summary)

YandexMusicModel
- ArtistEvent

Index

Constructors

Properties

artist? client? similarToArtistsFromHistory? tracks?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`artist

artist?: Artist

The artist.

`Optional`client

client?: Client

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

`Optional`similarToArtistsFromHistory

similarToArtistsFromHistory?: Artist[]

Similar artists derived from listening history.

`Optional`tracks

tracks?: Track[]

Tracks surfaced from the artist.

Methods

`Static`deJson

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

`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