search

spotify-api / spotify-api.js

A complete wrapper for spotify web api for deno, node.js and the browser.
https://spotify-api.js.org
MIT License
211 stars 19 forks source link

Expose total for paginated APIs #228

Open timrae opened 1 year ago

timrae commented 1 year ago

Feature Request

Some Spotify APIs use a paginated response model. For example in the ArtistManager class, the search() and getAlbums() functions take a limit and offset parameter which can be used to specify the page number and size.

Unfortunately these functions do not expose the total number of items, so in general the developer doesn't know whether or not there are more items able to be read. In this case it could be necessary to make one api call more than necessary to ensure that all items have been fetched.

In these instances it would be useful to return the raw response data (which includes the .total member) instead of the .items data member, to allow the developer to optimize performance.

scientific-dev commented 1 year ago

The spotify-types, spotify-api.js and their documentation are outdated for a few functions. The updates will be made in the upcomming version which will take some time (probably more than a month).

johnyvelho commented 1 year ago

using user.getPlaylists() and would also be nice to have pagination metadata like .total, .next, etc.