useshortcut / shortcut-client-js

The official JavaScript client library for the Shortcut (formerly Clubhouse) REST API.
https://useshortcut.github.io/shortcut-client-js/
133 stars 31 forks source link

Paginator #138

Open ad-m-ss opened 2 years ago

ad-m-ss commented 2 years ago

Hi,

Could you add the recommended way how to play with paginator? Many SDKs don't offer much more than building simple requests, but they expect the SDK to facilitate a certain abstraction. You can use async generators to make remote data "native" (see example iterator in GitHub SDK https://octokit.github.io/rest.js/v18#pagination , alternatively paginator in AWS SDK - https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#paginators ).

Available https://github.com/useshortcut/shortcut-client-js/tree/main/examples does not even attempt to reach that.

API response requires to the following URL, which is quite raw, and using raw API requests undermines the sense of the SDK.

Kind regards