Class AlbumTrailer

An album together with its trailer.

Hierarchy (View Summary)

YandexMusicModel
- AlbumTrailer

Index

Constructors

Properties

album? artists? client? trailer?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`album

album?: Album

The album.

`Optional`artists

artists?: Artist[]

Related artists.

`Optional`client

client?: Client

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

`Optional`trailer

trailer?: TrailerInfo

The trailer.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): AlbumTrailer | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns AlbumTrailer | null
See
AlbumTrailer
- Defined in src/models/album/albumExtras.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