Class PlaylistTrailer

A playlist together with its trailer.

Hierarchy (View Summary)

YandexMusicModel
- PlaylistTrailer

Index

Constructors

Properties

client? playlist? shareable? trailer?

Methods

deJson requireClient

Constructors

constructor

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

playlist?: Playlist

The playlist.

`Optional`shareable

shareable?: boolean

Whether the trailer is shareable.

`Optional`trailer

trailer?: TrailerInfo

The trailer.

Methods

`Static`deJson

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

`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