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

Add TypeScript types #34

Closed
JamieMagee opened this issue Jul 2, 2020 · 5 comments · Fixed by #35
Closed

Add TypeScript types #34

JamieMagee opened this issue Jul 2, 2020 · 5 comments · Fixed by #35
Labels

Comments

@JamieMagee
Copy link

I currently have a PR open, DefinitelyTyped/DefinitelyTyped#45824, to add types for @snyk/ruby-semver. However, it would be nice if these could be maintained and shipped with the actual package, instead of under @types/snyk__ruby-semver.

I'm still hoping to get some feedback from the DefinitelyTyped maintainers on my implementation, but are you open to the idea?

@JamieMagee JamieMagee changed the title Add TypeScript Types Add TypeScript types Jul 2, 2020
@FauxFaux
Copy link
Contributor

FauxFaux commented Jul 2, 2020

We're a typescript company. We're more likely to rewrite the whole thing in Typescript. 😄

@FauxFaux
Copy link
Contributor

FauxFaux commented Jul 2, 2020

I did that without looking at your types. I think we should expose the Maybe* types, instead of just string. I don't think we can expose that Comparison type, the function probably does take strings in the real world.

I didn't type up the internals. Do you care?

@JamieMagee
Copy link
Author

Thanks for this!

Agree with the Maybe types. Exposing the Comparator type should be fine. The type information isn't present in JavaScript, and as this is a port to TypeScript there's no breaking change.

I would like the internals, if it's not too much trouble. They seem pretty straightforward from my typing of them.

@snyksec
Copy link

snyksec commented Jul 6, 2020

🎉 This issue has been resolved in version 3.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@JamieMagee
Copy link
Author

Thank you!

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

Successfully merging a pull request may close this issue.

3 participants