Skip to content
Client
Server

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

Type Alias: tViewPage<Views, K> ​

ts
type tViewPage<Views, K> = Omit<tRelationshipViewResponse, "data" | "attributes"> & object;

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

What Apple answers when a view is asked for by name: a page of what it holds, with the view's own attributes when they were asked for. Both are typed from the view, so that a validator of the view is a validator of this page.

Type Parameters ​

Views ​

Views

K ​

K extends keyof Views

Type Declaration ​

attributes? ​

ts
optional attributes?: tViewAttributesOf<Views, K>;

The view's own attributes, such as its title: there when with: ["attributes"] asked for them, on the first page alone.

data ​

ts
data: tRelated<Views, K>[];

What the view holds, this page of it: the resources the name asked for decides.

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