Class MusicHistoryItemId

Identifiers carried by a history item.

Hierarchy (View Summary)

YandexMusicModel
- MusicHistoryItemId

Index

Constructors

Properties

albumId? client? id? kind? seeds? trackId? uid?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`albumId

albumId?: string

Album id.

`Optional`client

client?: Client

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

`Optional`id

id?: string

Generic id.

`Optional`kind

kind?: string | number

Playlist kind.

`Optional`seeds

seeds?: string[]

Wave seeds.

`Optional`trackId

trackId?: string

Track id.

`Optional`uid

uid?: string | number

Owner uid (for playlists/waves).

Methods

`Static`deJson

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

`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