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

Interface: tResolveOptions

Defined in: lib/lib-playlists/src/resolve.ts:56

The options of resolve.

Extends

• tAskOptions
• tPaceOptions
• tStorefrontOption

Properties

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

---

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

---

storefront?

readonly optional storefront?: string;

Defined in: packages/core/src/endpoint.ts:367

The storefront whose catalog is asked, by its id, such as "gb". Default: the client's, which is the one it was created with, or else the listener's, which the client looks up once.

Inherited from

tStorefrontOption.storefront