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

Function: getStorefront()

function getStorefront(
   client, 
   id, 
   options?
): Promise<tStorefrontsResponse>;

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

The storefront with an id, such as "gb".

Parameters

client

tAppleMusicClient

The client to ask with.

id

string

The storefront's id.

options?

tEndpointOptions<tStorefrontsResponse, object, object>

What to send beside the storefront.

Returns

Promise<tStorefrontsResponse>

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