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

Function: addLibraryPlaylistTracks()

function addLibraryPlaylistTracks(
   client, 
   id, 
   tracks, 
   options?
): Promise<void>;

Defined in: clients/client-user/src/library.ts:185

Adds tracks to the end of a playlist in the listener's library: [{ id, type: "songs" }]. It resolves to nothing.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

id

string

The library playlist's id.

tracks

readonly tLibraryPlaylistTracksRequestData[]

What to add, 1 to 300 of them, each by id and type; nothing else of a track is sent.

options?

tAddOptions

What else to send with the request, such as a signal to abort it with.

Returns

Promise<void>

Nothing: it resolves once Apple has accepted the tracks.

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.