Class ArtistAbout

The "about" block of an artist (/artists/{id}/about-artist).

Hierarchy (View Summary)

YandexMusicModel
- ArtistAbout

Index

Constructors

Properties

artist? artistType? client? covers? description? donations? links? stats?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`artist

artist?: Artist

The artist.

`Optional`artistType

artistType?: string

Artist type.

`Optional`client

client?: Client

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

`Optional`covers

covers?: Cover[]

All available covers.

`Optional`description

description?: string

Artist description.

`Optional`donations

donations?: ArtistDonationItem[]

Donation blocks.

`Optional`links

links?: Link[]

External links.

`Optional`stats

stats?: Stats

Listening statistics.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): ArtistAbout | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns ArtistAbout | null
See
ArtistAbout
- Defined in src/models/artist/artistExtras.ts:333

`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