Class PlaylistId

A lightweight reference to a playlist by its owner uid and kind.

Hierarchy (View Summary)

YandexMusicModel
- PlaylistId

Index

Constructors

Properties

client? kind? uid?

Accessors

Methods

deJson requireClient

Constructors

constructor

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

kind?: number

Playlist kind (per-owner ordinal).

`Optional`uid

uid?: number

Owner user id.

Accessors

playlistId

get playlistId(): string
The canonical uid:kind playlist identifier.

Returns string
- Defined in src/models/playlist/playlistId.ts:18

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): PlaylistId | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns PlaylistId | null
See
PlaylistId
- Defined in src/models/playlist/playlistId.ts:23

`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