Are the (cursor) => examples in the README.md expected to work?

[williammartin]

I’ve been going through the examples in the README, but I can’t seem to get the examples with the (cursor) => pattern to work.

For example taking the TS example and making it JS:

octokit.graphql.paginate((cursor) => {
  return `{
      repository(owner: "octokit", name: "rest.js") {
        issues(first: 10, after: ${cursor.create()}) {
          nodes {
            title
          }
          pageInfo {
            hasNextPage
            endCursor
          }
        }
      }
    }`;
}).then(console.log);

I get one of these gnarly errors:

/Users/williammartin/workspace/octokit-playground/node_modules/@octokit/graphql/dist-node/index.js:113
      throw new GraphqlResponseError(
            ^

GraphqlResponseError: Request failed due to following response errors:
 - A query attribute must be specified and must be a string.

I also can’t find any examples in the wild of this pattern of usage:

https://github.com/search?type=code&q=%2Foctokit%5C.graphql%5C.paginate%3C.*%3E%5C%28%5C%28cursor%5C%29%2F
https://github.com/search?type=code&q=octokit.graphql.paginate%28%28cursor%29

And my pretty questionable TS reading of the type signature tells me this shouldn’t be possible?

plugin-paginate-graphql.js/src/paginate.ts

Lines 7 to 11 in 8e3bce1

	return async <ResponseType extends object = any>(
	query: string,
	initialParameters: Record<string, any> = {},
	): Promise<ResponseType> => {
	let mergedResponse: ResponseType = {} as ResponseType;

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[williammartin]

Since I cloned this repo to add some automated tests I actually tried to use this shape of request with TypeScript and it doesn't typecheck so I can't see how these examples would ever have worked: