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

Interface: tReadPlaylistOptions

Defined in: lib/lib-playlists/src/read.ts:13

The options of read.

Extends

• tAskOptions
• tLimitOptions

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.

Inherited from

tLimitOptions.maxPages

---

onProgress?

readonly optional onProgress?: (progress) => void;

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

Called each time more tracks are done with. What it throws stops the verb, and is what the verb rejects with.

Parameters

progress

tProgress

Returns

void

Inherited from

tAskOptions.onProgress

---

signal?

readonly optional signal?: AbortSignal;

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

Aborts the verb: the request in flight, and any wait between requests. An abort is rethrown as it is.

Inherited from

tAskOptions.signal