Reference / @open-music-sdk/client-catalog / getPlaylist

Function: getPlaylist()

function getPlaylist(
   client, 
   id, 
   options?
): Promise<tPlaylistsResponse>;

Defined in: clients/client-catalog/src/resources.ts:421

The playlist with an id.

Parameters

client

tAppleMusicClient

The client to ask with.

id

string

The playlist's id.

options?

tEndpointOptions<tPlaylistsResponse, tStorefrontOption, tViewsOption<tPlaylistViews>>

The storefront to ask in, the views to send with the playlist, and what else to send beside it.

Returns

Promise<tPlaylistsResponse>

What Apple answered: the playlist under data.

Throws

TypeError if client is no client or an argument is not what it should be, before Apple is asked.

Throws

AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues; _tag says which.

Throws

The reason options.signal aborted with, when it does.

Throws

Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.