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

Function: getSearchHints()

function getSearchHints(
   client, 
   term, 
   options?
): Promise<tSearchHintsResponse>;

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

The terms a search might be for, given the start of one: what to offer as someone types.

Parameters

client

tAppleMusicClient

The client to ask with.

term

string

The start of a search, 1 to 256 characters.

options?

tSearchHintsOptions

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

Returns

Promise<tSearchHintsResponse>

What Apple answered: the terms under results.terms.

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.