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 type declaration file #277

Open
vreynolds opened this issue Jun 16, 2022 · 0 comments
Open

Add type declaration file #277

vreynolds opened this issue Jun 16, 2022 · 0 comments

Comments

@vreynolds
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Related to #88
TypeScript users are missing out on the benefits of a typed API for the library, because we don't have types.

Describe the solution you'd like
Add a type declaration file.

This is the first step in the TS port project, which will allow us to understand the library API and provide user value faster, while we continue on porting the rest of the library to TS.

Describe alternatives you've considered
Wait until we complete the TS port. In the long run, it's more maintainable to have the source code written in TS instead of the standalone types file. We intend to replace the standalone types file soon, so the tradeoff seems worthwhile in this case.

Additional context

@vreynolds vreynolds added this to the TypeScript port milestone Jun 16, 2022
@vreynolds vreynolds changed the title Type declaration file Add type declaration file Jul 1, 2022
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