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

Function: getPlaylistsByStorefrontChart()

function getPlaylistsByStorefrontChart(
   client, 
   values, 
   options?
): Promise<tPlaylistsResponse>;

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

The chart playlists of the storefronts with the ids given: each storefront's own charts, kept as playlists.

Parameters

client

tAppleMusicClient

The client to ask with.

values

readonly string[]

The storefronts' ids, 1 to 300 of them; each one such as "gb".

options?

tEndpointOptions<tPlaylistsResponse, tStorefrontOption, object>

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

Returns

Promise<tPlaylistsResponse>

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