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

Function: getLibraryAlbums()

function getLibraryAlbums(
   client, 
   ids, 
   options?
): Promise<tLibraryAlbumsResponse>;

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

The albums with the ids given in the listener's library.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

ids

readonly string[]

The library albums' ids, 1 to 300 of them.

options?

tEndpointOptions<tLibraryAlbumsResponse, object, object>

What to send beside the albums.

Returns

Promise<tLibraryAlbumsResponse>

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