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

Function: getLanguageTag()

function getLanguageTag(
   client, 
   acceptLanguage, 
   options?
): Promise<tLangageTagResponse>;

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

The language a storefront would answer in, given the ones a reader accepts, best first, such as ["fr-CA", "fr", "en"]: the tag to pass as language to the other functions.

Parameters

client

tAppleMusicClient

The client to ask with.

acceptLanguage

readonly string[]

The languages a reader accepts, best first, as tags such as "fr-CA", 1 to 300 of them.

options?

tLanguageTagOptions

The storefront to ask about, and what to send beside the tag.

Returns

Promise<tLangageTagResponse>

What Apple answered: the tag under results.tag.

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.