Skip to content
Client
Server

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

Function: getRecordLabel() ​

ts
function getRecordLabel(
   client, 
   id, 
   options?
): Promise<tRecordLabelsResponse>;

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

The record label with an id.

Parameters ​

client ​

tAppleMusicClient

The client to ask with.

id ​

string

The record label's id.

options? ​

tEndpointOptions<tRecordLabelsResponse, tStorefrontOption, tViewsOption<tRecordLabelViews>>

The storefront to ask in, the views to send with the record label, and what else to send beside it.

Returns ​

Promise<tRecordLabelsResponse>

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