Skip to content
Client
Server

Reference / @open-music-sdk/core / tWalkOptions

Interface: tWalkOptions ​

Defined in: packages/core/src/options.ts:53

What a function that walks pages takes beside the rest: how far a walk may go.

Properties ​

maxPages? ​

ts
readonly optional maxPages?: number;

Defined in: packages/core/src/options.ts:59

The most pages a walk may ask Apple for: a whole number above zero. Default: no limit, so a walk goes on for as long as each page names a next one. It is the walk's alone: called with a client, a function asks for the one page it resolves to, whatever this says.

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