Class AlbumSimilarEntities

Entities similar to an album (used for curated coloring/recommendations).

Hierarchy (View Summary)

YandexMusicModel
- AlbumSimilarEntities

Index

Constructors

Properties

Methods

deJson requireClient

Constructors

constructor

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

items?: JSONValue[]

Similar entity items (raw JSON, pending a typed SimilarEntityItem model).

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): AlbumSimilarEntities | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns AlbumSimilarEntities | null
See
AlbumSimilarEntities
- Defined in src/models/album/albumExtras.ts:42

`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