Class MusicHistoryItem

A typed entry within a history group (a context or a track).

Hierarchy (View Summary)

YandexMusicModel
- MusicHistoryItem

Index

Constructors

Properties

client? data? type?

Methods

deJson requireClient

Constructors

constructor

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

data?: MusicHistoryItemData

The entry payload.

`Optional`type

type?: string

Entry type, for example track or a context kind.

Methods

`Static`deJson

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

`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