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

Interface: tApplyOptions

Defined in: lib/lib-playlists/src/apply.ts:29

The options of apply.

Extends

• tAskOptions
• tPaceOptions
• tLimitOptions

Properties

chunk?

readonly optional chunk?: number;

Defined in: lib/lib-playlists/src/apply.ts:34

How many tracks go in one request: a whole number from 1 to 300, the most the client's function takes. Default 300, which one request took against the live API on 18 October 2026.

---

delayMs?

readonly optional delayMs?: number;

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

How long to wait between the requests a verb makes one after another for the same thing, in milliseconds: every request of resolve, and in apply the requests that add tracks, not the reads before and after them. Default 0: no wait. The client's own rate limiter and its wait after a 429 apply underneath, whatever this says.

Inherited from

tPaceOptions.delayMs

---

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

---

settle?

readonly optional settle?: tSettleOptions;

Defined in: lib/lib-playlists/src/apply.ts:36

How long a write is given to show in a read.

---

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