HelixPaginatedRequest<D, T>
Represents a request to the new Twitch API (Helix) that utilizes a cursor to paginate through its results.
Overview
Properties
Aside from the methods described below, you can also utilize the async iterator using for await .. of:
const result = client.helix.videos.getVideosByUserPaginated('125328655');
for await (const video of result) {
console.log(video.title);
}
Properties
current
Type: ?Array<D>
The last retrieved page of data associated to the requested resource.
Only works with HelixPaginatedRequest#getNext and not with any other methods of data retrieval.
currentCursor
Type: ?string
Retrieves the current cursor.
Only useful if you want to make manual requests to the API.
Methods
getAll()
asyncRetrieves and returns all data associated to the requested resource.
Be aware that this makes multiple calls to the Twitch API. Due to this, you might be more suspectible to rate limits.
Also be aware that this resets the internal cursor, so avoid using this and HelixPaginatedRequest#getNext together.
getNext()
asyncRetrieves and returns the next available page of data associated to the requested resource, or an empty array if there are no more available pages.
reset()
Resets the internal cursor.
This will make HelixPaginatedRequest#getNext start from the first page again.