Skip to content
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.

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

feat(typescript): typescript definitions #396

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gr2m
Copy link
Contributor

@gr2m gr2m commented Jun 29, 2021

fixes #84

  • generate types
  • add types for enterprise-admin endpoints

We currently only maintain the Endpoint types for api.github.com in @octokit/types/src/generated/Endpoints.ts. Ideally we would start generating endpoint types for all GHES versions and GHAE, but that will be a bigger effort. For the time being it might be worth to figure out a workaround to unblock this pull request

@gr2m gr2m added Type: Feature New feature or request typescript Relevant to TypeScript users only labels Jun 29, 2021
@ghost ghost added this to Inbox in JS Jun 29, 2021
@gr2m gr2m force-pushed the 84/typescript-definitions branch from 8164819 to 303e650 Compare June 29, 2021 05:50
@ghost ghost moved this from Inbox to Features in JS Jun 29, 2021
@gr2m gr2m self-assigned this Jun 30, 2021
@ghost ghost moved this from Features to In progress in JS Jun 30, 2021
@gr2m gr2m removed their assignment Aug 12, 2021
@ghost ghost moved this from In progress to Features in JS Aug 12, 2021
@gr2m
Copy link
Contributor Author

gr2m commented Oct 13, 2022

This is solved in the WIP https://github.com/octokit/octokit-next.js. No endpoints types are loaded by default, they have to be loaded explicitly, e.g. @octokit-next/types-rest-api to load endpoints for api.github.com, or @octokit-next/types-rest-api-ghec to load endpoints for GitHub Enterprise Cloud.

I'm not sure if it is worth the effort to to continue working on this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature New feature or request typescript Relevant to TypeScript users only
Projects
No open projects
JS
  
Features
Development

Successfully merging this pull request may close these issues.

Add TypeScript definitions for added methods
1 participant