-
Notifications
You must be signed in to change notification settings - Fork 331
Convert type OctokitOptions to interface OctokitOptions #449
Copy link
Copy link
Closed
Labels
Type: FeatureNew feature or requestNew feature or request
Description
What’s missing?
To convert type OctokitOptions to interface OctokitOptions would open the door to make more accurate types for Octokit Plugins with specific required options like @octokit/plugin-throttling:
Why?
When trying to deprecate a property for the option object provided to @octokit/plugin-throttling I noticed there is not a good typing to be able to do so.
Also, we are missing all the benefits from a good TS typing for this and other plugins (auto-completion, catch errors on build time, etc...)
Alternatives you tried
You can see this draft PR (octokit/plugin-throttling.js#457) where we did a bit of experimentation but @G-Rath come up with a great solution which implies this change in @octokit/core.js types:
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Type: FeatureNew feature or requestNew feature or request