@dvxch/yandex-music
    Preparing search index...

    Class Metatag

    Aggregate metatag information (artists, albums and playlists).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    albums? albumsSortByValues? artists? client? color? composers? coverUri? customWaveAnimationUrl? features? id? liked? playlists? playlistsSortByValues? promotions? stationId? title? tracks? tracksSortByValues?

    Methods

    deJson requireClient

    Constructors

    Properties

    albums?: Album[]

    Featured albums.

    albumsSortByValues?: MetatagSortByValue[]

    Available album sort options.

    artists?: Artist[]

    Featured artists.

    client?: Client

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

    color?: string

    Accent color.

    composers?: Artist[]

    Featured composers.

    coverUri?: string

    Cover URI template.

    customWaveAnimationUrl?: string

    Custom wave animation URL.

    features?: JSONValue

    Featured entities (free-form raw JSON, pending a typed model).

    id?: string

    Metatag id.

    liked?: boolean

    Whether the metatag is liked.

    playlists?: Playlist[]

    Featured playlists.

    playlistsSortByValues?: MetatagSortByValue[]

    Available playlist sort options.

    promotions?: JSONValue

    Promotions (free-form raw JSON, pending a typed model).

    stationId?: string

    Radio station id for the metatag.

    title?: MetatagTitle

    Title.

    tracks?: Track[]

    Featured tracks.

    tracksSortByValues?: MetatagSortByValue[]

    Available track sort options.

    Methods

    • 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.

      When the model was created without a client.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods