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

Function: getSearchSuggestions()

function getSearchSuggestions(
   client, 
   term, 
   options
): Promise<tSearchSuggestionsResponse>;

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

Suggestions for a search, given the start of one: terms to search for, resources that match, or both.

Parameters

client

tAppleMusicClient

The client to ask with.

term

string

The start of a search, 1 to 256 characters.

options

tSearchSuggestionsOptions

The kinds of suggestion to make, which have to be given; the types the top results may be; the storefront to ask in; and what to send beside the suggestions.

Returns

Promise<tSearchSuggestionsResponse>

What Apple answered: the suggestions under results.suggestions, each saying its kind.

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.