sarsoo/Spotify.NET
1
0
Fork 0
mirror of https://github.com/Sarsoo/Spotify.NET.git synced 2024-12-23 14:46:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Removed invalid syntax from pagination docs

Browse Source
This commit is contained in:
Jonas Dellinger 2020-06-15 22:39:43 +02:00
parent 5ac1077cfe
commit 76f1a4746e
1 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
SpotifyAPI.Docs/docs/pagination.md
View File

@ -14,10 +14,8 @@ It allows to receive only a subset of all available data and dynamically check i
`PaginateAll` will query all remaining elements based on a first page and return all of them in a `IList`. This method should not be used for a huge amount of pages (e.g `Search` Endpoint), since it stores every response in memory. `PaginateAll` will query all remaining elements based on a first page and return all of them in a `IList`. This method should not be used for a huge amount of pages (e.g `Search` Endpoint), since it stores every response in memory.
```csharp ```csharp
// we need the first page, every syntax can be used for pagination // we need the first page
var page = await spotify.Playlists.CurrentUsers(); var page = await spotify.Playlists.CurrentUsers();
var page = spotify.Playlists.CurrentUsers();
var page = () => spotify.Playlists.CurrentUsers();
// allPages will include the first page retrived before // allPages will include the first page retrived before
var allPages = await spotify.PaginateAll(page); var allPages = await spotify.PaginateAll(page);
@ -31,10 +29,8 @@ var allPages = await spotify.PaginateAll(page);
`Paginate` is based on `IAsyncEnumerable` and streams pages instead of returning them all in one list. This allows to break the fetching early and keeps only 1 page in memory at a time. This method should always be preferred to `PaginateAll` `Paginate` is based on `IAsyncEnumerable` and streams pages instead of returning them all in one list. This allows to break the fetching early and keeps only 1 page in memory at a time. This method should always be preferred to `PaginateAll`
```csharp ```csharp
// we need the first page, every syntax can be used for pagination // we need the first page
var page = await spotify.Playlists.CurrentUsers(); var page = await spotify.Playlists.CurrentUsers();
var page = spotify.Playlists.CurrentUsers();
var page = () => spotify.Playlists.CurrentUsers();
await foreach(var item in spotify.Paginate(page)) await foreach(var item in spotify.Paginate(page))
{ {