feat: paginatingEndpoints and isPaginatingEndpoint

[ptomulik]

The isPaginatingEndpoint function provides a runtime type-guard for keyof PaginatingEndpoint. The PR also exposes paginatingEndpoints array that lists all the keys in the generated PaginatingEndpoints interface.

[gr2m]

Can you add tests for the new exports to https://github.com/octokit/plugin-paginate-rest.js/blob/master/test/smoke.test.ts?

As this adds features, we should update the docs.

Can you add the new exports to the imports in https://github.com/octokit/plugin-paginate-rest.js/tree/42df25d3ccfcdb27194032d6a77d2495af085a6a#usage and add sections for each export to the doc?

[ptomulik]

Can you add tests for the new exports to https://github.com/octokit/plugin-paginate-rest.js/blob/master/test/smoke.test.ts?

Tests are already in test/paginating-endpoints.test.ts. Anything specific that should be additionally tested in smoke.test.ts?

As this adds features, we should update the docs.

Can you add the new exports to the imports in https://github.com/octokit/plugin-paginate-rest.js/tree/42df25d3ccfcdb27194032d6a77d2495af085a6a#usage and add sections for each export to the doc?

Sure.

[gr2m]

Anything specific that should be additionally tested in smoke.test.ts?

I just like to test all exports of a module in the smoke test. Only import the function and the array and check that they are a function/array respectively. It's just an additional safety measure to avoid accidental breaking changes

[ptomulik]

Ok, added the smoke test. All the changes to README are already provided in #284.

[gr2m]

Thanks!

[github-actions]

🎉 This PR is included in version 2.13.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀