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

Consider using JSDoc to generate TypeScript types #418

Closed
lance opened this issue May 7, 2020 · 3 comments
Closed

Consider using JSDoc to generate TypeScript types #418

lance opened this issue May 7, 2020 · 3 comments

Comments

@lance
Copy link
Member

lance commented May 7, 2020

The opossum TypeScript types are currently maintained by community contributors, which is great. However, this requires that these folks keep up with API changes and update the types accordingly. Based on my quick read of this article, it seems like it would be possible to maintain these in this repository, and have the types automatically generated with JSDoc. It might go a good ways towards ensuring that the types and the API don't get out of sync.

@lholmquist
Copy link
Member

that could be interesting. Just as long as we aren't changing code to accommodate how JSDoc works.

@lance
Copy link
Member Author

lance commented May 14, 2020

Here is the impl I recently did for CE: cloudevents/sdk-javascript#155

@github-actions
Copy link
Contributor

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants