Class MusicHistoryItemData

The payload of a single history item.

Hierarchy (View Summary)

YandexMusicModel
- MusicHistoryItemData

Index

Constructors

Properties

client? fullModel? itemId?

Methods

deJson requireClient

Constructors

constructor

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

fullModel?: JSONValue

The full entity (a Track or context model) as raw JSON.

`Optional`itemId

itemId?: MusicHistoryItemId

The item identifiers.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): MusicHistoryItemData | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns MusicHistoryItemData | null
See
MusicHistoryItemData
- Defined in src/models/musicHistory/musicHistory.ts:51

`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