Reference / @open-music-sdk/lib-playlists / tLimitOptions

Interface: tLimitOptions

Defined in: lib/lib-playlists/src/options.ts:39

What a verb that reads one of the listener's collections whole takes beside: how far it may walk.

Extended by

• tApplyOptions
• tReadPlaylistOptions

Properties

maxPages?

readonly optional maxPages?: number;

Defined in: lib/lib-playlists/src/options.ts:45

The most pages one walk may ask Apple for: a whole number from 1. Default: no limit, so a walk goes on for as long as each page names a next one. A playlist, or a list of playlists, that runs past it is not read short: the verb rejects with an ApiError, since what was read is not all there is.