Reference / @open-music-sdk/client-catalog / getAlbum

Function: getAlbum()

function getAlbum(
   client, 
   id, 
   options?
): Promise<tAlbumsResponse>;

Defined in: clients/client-catalog/src/resources.ts:250

The album with an id.

Parameters

client

tAppleMusicClient

The client to ask with.

id

string

The album's id.

options?

tEndpointOptions<tAlbumsResponse, tStorefrontOption, tViewsOption<tAlbumViews>>

The storefront to ask in, the views to send with the album, and what else to send beside it.

Returns

Promise<tAlbumsResponse>

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, if the client has no storefront to ask in, 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.