Class Icon

A square icon with a background color (used by genres, tags, etc.).

Hierarchy (View Summary)

YandexMusicModel
- Icon

Index

Constructors

Properties

backgroundColor? client? imageUrl?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`backgroundColor

backgroundColor?: string

Background color in hex.

`Optional`client

client?: Client

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

`Optional`imageUrl

imageUrl?: string

URI template of the icon image.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): Icon | null
Deserialize an Icon.
Parameters
- raw: JSONValue | undefined
  Raw JSON value from the API.
- Optionalclient: Client
  The owning client.
Returns Icon | null
The model, or null when raw is not an object.
- Defined in src/models/common.ts:127

`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