Reference / @open-music-sdk/client-user / getUserStorefront

Function: getUserStorefront()

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

Defined in: clients/client-user/src/library.ts:365

The storefront the listener's account is in: the one whose catalog they see.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

options?

tUserStorefrontOptions

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.