Skip to content
Client
Server

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

Function: getAppleCurator() ​

ts
function getAppleCurator(
   client, 
   id, 
   options?
): Promise<tAppleCuratorsResponse>;

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

The Apple curator with an id.

Parameters ​

client ​

tAppleMusicClient

The client to ask with.

id ​

string

The Apple curator's id.

options? ​

tEndpointOptions<tAppleCuratorsResponse, tStorefrontOption, object>

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

Returns ​

Promise<tAppleCuratorsResponse>

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

MIT licensed. Not affiliated with, endorsed by, or sponsored by Apple Inc. Apple Music and MusicKit are trademarks of Apple Inc.