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

    Class BlockEntity

    A single item inside a landing block (album, playlist, promotion, …).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client? data? description? descriptionFormatted? id? lastUpdated? type?

    Methods

    deJson requireClient

    Constructors

    Properties

    client?: Client

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

    data?: BlockEntityData

    The polymorphic entity payload, deserialized according to type. Unknown types fall back to the raw JSON value.

    description?: string

    Entity description.

    descriptionFormatted?: string

    Formatted (HTML) entity description.

    id?: string

    Entity id.

    lastUpdated?: string

    Last-updated timestamp (ISO 8601).

    type?: string

    Entity type, which drives the shape of data.

    Known values: personal-playlist, promotion, album, playlist, chart-item, play-context, mix-link.

    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