Class Pagination<I>

Get a new IBM Cloud SDK style Pager for the operation.

This type is useful for retrieving one page at a time through a function call.

Get an AsyncIterableIterator for all the pages.

This function is useful for handling pages in an enhanced for loop e.g.

for await (const row: ReadonlyArray<DocsResultRow> of Pagination.newPagination(client, PagerType.POST_ALL_DOCS, allDocsParams).pages()){
  ...
}
Copy

Get a page by page stream of all the pages.

Get an AsyncIterableIterator for all the rows from all the pages.

This function is useful for handling rows in an enhanced for loop e.g.

for await (const row: DocsResultRow of Pagination.newPagination(client, PagerType.POST_ALL_DOCS, allDocsParams).rows()) {
  ...
}
Copy

Get a row by row stream of all the rows from all the pages.

Get a Pagination for the postAllDocs operation. The page size is configured with the limit parameter of the params.

Get a Pagination for the postPartitionAllDocs operation. The page size is configured with the limit parameter of the params.

Get a Pagination for the postDesignDocs operation. The page size is configured with the limit parameter of the params.

Get a Pagination for the postFind operation. The page size is configured with the limit parameter of the params.

Get a Pagination for the postPartitionFind operation. The page size is configured with the limit parameter of the params.

Get a Pagination for the postSearch operation. The page size is configured with the limit parameter of the params.

Get a Pagination for the postPartitionSearch operation. The page size is configured with the limit parameter of the params.

Get a Pagination for the postView operation. The page size is configured with the limit parameter of the params.

Get a Pagination for the postPartitionView operation. The page size is configured with the limit parameter of the params.