docs: add comment to export

octokit · Apr 30, 2024 · 5596fa6 · 5596fa6
1 parent e8f3d33
commit 5596fa6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -4,6 +4,8 @@ import { createPaginate } from "./paginate.js";
 export type { PageInfoForward, PageInfoBackward } from "./page-info.js";
 export { VERSION } from "./version.js";
 
+// Export the paginateGraphQLInterface type in order to fix TypeScript errors in downstream projects
+// The inferred type of 'Octokit' cannot be named without a reference to '@octokit/core/node_modules/@octokit/graphql/types'. This is likely not portable. A type annotation is necessary.
 export type paginateGraphQLInterface = {
   graphql: Octokit["graphql"] & {
     paginate: ReturnType<typeof createPaginate> & {