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

    Class Search

    Full search response across all entity types.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    albums? artists? best? client? clips? misspellCorrected? misspellOriginal? misspellResult? nocorrect? page? perPage? playlists? podcastEpisodes? podcasts? searchRequestId? text? tracks? type? users? videos?

    Methods

    deJson requireClient

    Constructors

    Properties

    albums?: SearchResult<Album>

    Matching albums.

    artists?: SearchResult<Artist>

    Matching artists.

    best?: Best

    The single best match.

    client?: Client

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

    clips?: SearchResult<Clip>

    Matching clips (short videos).

    misspellCorrected?: boolean

    Whether the query was auto-corrected.

    misspellOriginal?: string

    Original (mis-spelled) query text.

    misspellResult?: string

    Corrected query text, when a misspelling was detected.

    nocorrect?: boolean

    Whether correction was disabled.

    Optionalpage

    page?: number

    Page index.

    perPage?: number

    Results per page.

    playlists?: SearchResult<Playlist>

    Matching playlists.

    podcastEpisodes?: SearchResult<Track>

    Matching podcast episodes (modeled as tracks).

    podcasts?: SearchResult<Album>

    Matching podcasts (modeled as albums).

    searchRequestId?: string

    Unique id of the search request.

    Optionaltext

    text?: string

    Echoed query text.

    tracks?: SearchResult<Track>

    Matching tracks.

    type?: string

    Result type filter that was applied.

    users?: SearchResult<User>

    Matching users.

    videos?: SearchResult<Video>

    Matching videos.

    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