Reference / @open-music-sdk/client-user / getLibraryPlaylist

Function: getLibraryPlaylist()

function getLibraryPlaylist(
   client, 
   id, 
   options?
): Promise<tLibraryPlaylistsResponse>;

Defined in: clients/client-user/src/resources.ts:287

The playlist with an id in the listener's library.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

id

string

The library playlist's id.

options?

tEndpointOptions<tLibraryPlaylistsResponse, object, object>

What to send beside the playlist.

Returns

Promise<tLibraryPlaylistsResponse>

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