Skip to content

fix: explicit type annotations for throttle callbacks broken by @octokit/plugin-retry v8.1.0 #1719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 2 commits into from
Closed

fix: explicit type annotations for throttle callbacks broken by @octokit/plugin-retry v8.1.0 #1719

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
939b1f6
Initial plan
Copilot Mar 6, 2026
2041490
fix: add explicit type annotations to throttle callbacks to fix TS er…
Copilot Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/client/github_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import type { ArgumentOptions } from "../arg_options.js";

const DEBUG_PER_PAGE = 10;

type ThrottleRequestOptions = { method: string; url: string };

export type WorkflowItem =
RestEndpointMethodTypes["actions"]["listRepoWorkflows"]["response"]["data"]["workflows"][0];
type WorkflowRunsItem =
Expand All @@ -33,7 +35,7 @@ export class GithubClient {
baseUrl: baseUrl ? baseUrl : "https://api.github.com",
log: options.debug ? console : undefined,
throttle: {
onRateLimit: (retryAfter, options, _octokit, retryCount) => {
onRateLimit: (retryAfter: number, options: ThrottleRequestOptions, _octokit: unknown, retryCount: number) => {
this.#octokit.log.warn(
`Request quota exhausted for request ${options.method} ${options.url}`,
);
Expand All @@ -43,7 +45,7 @@ export class GithubClient {
return true;
}
},
onSecondaryRateLimit: (_retryAfter, options, _octokit, _retryCount) => {
onSecondaryRateLimit: (_retryAfter: number, options: ThrottleRequestOptions, _octokit: unknown, _retryCount: number) => {
// does not retry, only logs a warning
this.#octokit.log.warn(
`Abuse detected for request ${options.method} ${options.url}`,
Expand Down