Class CoverDerivedColors

Colors derived from a cover image, used to theme players and cards.

Hierarchy (View Summary)

YandexMusicModel
- CoverDerivedColors

Index

Constructors

Properties

accent? average? client? miniPlayer? waveText?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`accent

accent?: string

Accent color.

`Optional`average

average?: string

Average color of the cover.

`Optional`client

client?: Client

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

`Optional`miniPlayer

miniPlayer?: string

Background color for the mini player.

`Optional`waveText

waveText?: string

Color suited for text drawn over the wave/animation.

Methods

`Static`deJson

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

`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