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

Function: getLibraryAlbum()

function getLibraryAlbum(
   client, 
   id, 
   options?
): Promise<tLibraryAlbumsResponse>;

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

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

Parameters

client

tAppleMusicClient

The listener's client to ask with.

id

string

The library album's id.

options?

tEndpointOptions<tLibraryAlbumsResponse, object, object>

What to send beside the album.

Returns

Promise<tLibraryAlbumsResponse>

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