Class ArtistAlbums

A page of an artist's albums (direct, also, discography or safe-direct).

Hierarchy (View Summary)

YandexMusicModel
- ArtistAlbums

Index

Constructors

Properties

albums? client? pager?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`albums

albums?: Album[]

The albums on this page.

`Optional`client

client?: Client

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

`Optional`pager

pager?: Pager

Pagination metadata.

Methods

`Static`deJson

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

`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