The current page number.
The first element index.
Whether the paginator reached the last page.
The current path.
Number of items per page.
Gets a raw data of the last retrieved page.
The last element index.
Total numbers of entities.
The total number of pages.
Makes it possible to use async iterator to sequentially loop over all available pages.
const apiClient = new ApiClient({ ...config });
const paginator = apiClient.donations.createDonationsPaginator();
for await (const data of paginator) {
...
}
HttpError if response status code is out of 200-299 range.
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.
MissingScopeError if the access token does not have required scope.
Gets all donations.
HttpError if response status code is out of 200-299 range.
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.
MissingScopeError if the access token does not have required scope.
Gets the next or the first page of donations.
Returns an empty array if the last page is reached.
HttpError if response status code is out of 200-299 range.
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.
MissingScopeError if the access token does not have required scope.
Gets donations by page number.
Returns empty array if the requested page is greater than the last page.
Page number to request. Default is 1.
HttpError if response status code is out of 200-299 range.
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.
MissingScopeError if the access token does not have required scope.
Gets the previous page of donations.
If the current page number is 1, then it returns it back.
HttpError if response status code is out of 200-299 range.
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.
MissingScopeError if the access token does not have required scope.
Generated using TypeDoc
Donation Alerts API paginator.
Allows fetching data by page, or all at once.