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

Function: getLibraryPlaylistFolderRelationship()

function getLibraryPlaylistFolderRelationship<K>(
   client, 
   id, 
   name, 
   options?
): Promise<tRelationshipPage<tLibraryPlaylistFolderRelationships, K>>;

Defined in: clients/client-user/src/resources.ts:407

One relationship of a library playlist folder, such as its children, a page at a time.

Type Parameters

K

K extends "children" | "parent"

Parameters

client

tAppleMusicClient

The listener's client to ask with.

id

string

The library playlist folder's id.

name

K

The relationship's name, one of the library playlist folder's as the type has them; Apple says whether there is such a one.

options?

tReadOptions<tRelationshipPage<tLibraryPlaylistFolderRelationships, K>> & object & tWalkOptions

How many to send in one page, where to start, what to send beside them, and the signal and schema of the request.

Returns

Promise<tRelationshipPage<tLibraryPlaylistFolderRelationships, K>>

What Apple answered: the first page, with next where there is more; maxPages plays no part.

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.