Class LandingList

A landing list of ids (new releases / new playlists / podcasts).

Hierarchy (View Summary)

YandexMusicModel
- LandingList

Index

Constructors

Properties

client? id? newPlaylists? newReleases? podcasts? title? type? typeForFrom?

Methods

deJson requireClient

Constructors

constructor

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

id?: string

List id.

`Optional`newPlaylists

newPlaylists?: JSONValue[]

New playlist references (raw JSON, pending a typed model).

`Optional`newReleases

newReleases?: number[]

New release album ids.

`Optional`podcasts

podcasts?: number[]

Podcast album ids.

`Optional`title

title?: string

List title.

`Optional`type

type?: string

List type.

`Optional`typeForFrom

typeForFrom?: string

Origin tag used in from parameters.

Methods

`Static`deJson

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

`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