Skip to content
Client
Server

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

Function: getRecordLabels() ​

ts
function getRecordLabels(
   client, 
   ids, 
   options?
): Promise<tRecordLabelsResponse>;

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

The record labels with the ids given.

Parameters ​

client ​

tAppleMusicClient

The client to ask with.

ids ​

readonly string[]

The record labels' ids, 1 to 300 of them.

options? ​

tEndpointOptions<tRecordLabelsResponse, tStorefrontOption, object>

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

Returns ​

Promise<tRecordLabelsResponse>

What Apple answered: the record labels 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.