Reference / @open-music-sdk/client-user / getMusicSummariesByYear

Function: getMusicSummariesByYear()

function getMusicSummariesByYear(
   client, 
   values, 
   options?
): Promise<tMusicSummariesResponse>;

Defined in: clients/client-user/src/library.ts:325

The listener's replay: a summary of what they played in each of the years given. The one year Apple takes at present is "latest".

Parameters

client

tAppleMusicClient

The listener's client to ask with.

values

readonly string[]

The years, 1 to 300 of them; "latest" is the one Apple takes at present.

options?

tEndpointOptions<tMusicSummariesResponse, object, tViewsOption<tMusicSummaryViews>>

The views to send with each summary, and what else to send beside it.

Returns

Promise<tMusicSummariesResponse>

What Apple answered: a summary for each year 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, 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.