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

Function: getAlbums()

function getAlbums(
   client, 
   ids, 
   options?
): Promise<tAlbumsResponse>;

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

The albums with the ids given.

Parameters

client

tAppleMusicClient

The client to ask with.

ids

readonly string[]

The albums' ids, 1 to 300 of them.

options?

tEndpointOptions<tAlbumsResponse, tStorefrontOption, object>

The storefront to ask in, and what to send beside the albums.

Returns

Promise<tAlbumsResponse>

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, 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.