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

Function: getCatalogResources()

function getCatalogResources(
   client, 
   ids, 
   options?
): Promise<tResourceCollectionResponse>;

Defined in: clients/client-catalog/src/discover.ts:182

Resources of several types in one request, by their ids: { songs: [...], albums: [...] }. One type at least has to be given.

Parameters

client

tAppleMusicClient

The client to ask with.

ids

Readonly<Partial<Record<tCatalogType, readonly string[] | undefined>>>

The ids by type, such as { songs: ["1"], albums: ["2"] }: 1 to 32 types with 1 to 300 ids between them; a type whose list is undefined is left out.

options?

tCatalogResourcesOptions

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

Returns

Promise<tResourceCollectionResponse>

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