GET /projects/columns/:column_id/cards TypeScript overload error about plugin-paginate-rest.js

[gr2m]

Thanks for reporting the issue Richard, I was able to reproduce it.

It looks like a problem with https://github.com/octokit/plugin-paginate-rest.js. Here is the most minimal test case I could come up with

import { Octokit as Core } from "@octokit/core";
import { paginateRest } from "@octokit/plugin-paginate-rest";

const Octokit = Core.plugin(paginateRest);

const octokit = new Octokit({
  auth: process.env.GITHUB_API_TOKEN,
  previews: ["inertia-preview"],
});

octokit
  .paginate("GET /projects/columns/:column_id/cards", {
    column_id: process.env.GITHUB_PROJECT_COLUMN_ID,
  })
  .then((cards) => {
    console.log(cards);
  });

I'm looking into it.

[gr2m]

The TypeScript error is not very helpful, but I think changing your code to this should resolve the problem (don't set previews in the Octokit constructor options, set previews on a per-request basis):

import { Octokit } from '@octokit/rest';

const octokit = new Octokit({
  auth: process.env.GITHUB_API_TOKEN,
});

octokit.paginate('GET /projects/columns/:column_id/cards', {
  column_id: process.env.GITHUB_PROJECT_COLUMN_ID,
  mediaType: {
    previews: ["inertia"],
  },
}).then((cards) => {
  console.log(cards);
});

The actual error message should be this

But somehow the interface overrides using a request method as first paramet are interfering.

By the way, as you use @octokit/rest, you can also do this now

await octokit.paginate(octokit.projects.listCards, {
  column_id: 123,
});

[github-actions]

🎉 This issue has been resolved in version 2.2.2 🎉

The release is available on:

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

Your semantic-release bot 📦🚀