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

Function: getAlbumsByEquivalents()

function getAlbumsByEquivalents(
   client, 
   values, 
   options?
): Promise<tAlbumsResponse>;

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

The albums in this storefront that are the equivalents of the albums with the ids given, which may be from another.

Parameters

client

tAppleMusicClient

The client to ask with.

values

readonly string[]

The ids of the albums to find the equivalents of, 1 to 300 of them; they may be another storefront's.

options?

tEndpointOptions<tAlbumsResponse, tStorefrontOption, tRestrictOption>

The storefront to ask in, which is where the equivalents are looked for; what to leave out of them; and what to send beside them.

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.