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

Function: createLibraryPlaylist()

function createLibraryPlaylist(
   client, 
   playlist, 
   options?
): Promise<tLibraryPlaylistsResponse>;

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

Makes a playlist in the listener's library: { attributes: { name } }, with its tracks and the folder to put it in under relationships. Resolves to the answer that holds the new playlist. Bound, it gives the playlist, or undefined if Apple's answer holds none: the playlist was made either way. The playlist has to be a plain object, and still one once made into JSON. It is copied as the call is made and sent as it is: what it holds is Apple's to judge, and nothing here limits its size, so limit it yourself if it comes from outside your app.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

playlist

tLibraryPlaylistCreationRequest

The playlist to make: its name under attributes, and its tracks and the folder to put it in under relationships.

options?

tCreateLibraryPlaylistOptions

The language to answer in, and what else to send with the request.

Returns

Promise<tLibraryPlaylistsResponse>

What Apple answered: the new 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.