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 Definitions #71

Merged
merged 3 commits into from
Sep 14, 2020
Merged

Add TypeScript Definitions #71

merged 3 commits into from
Sep 14, 2020

Conversation

kylegmaxwell
Copy link

Hi, Thank you for the great library. I am trying to use satellite.js in TypeScript which requires type definitions for the TypeScript compiler. I got it working locally, but would like to share the definitions so others can use your library in TypeScript as well.

I followed the contribution directions, except that I had to fork instead of branch since I don't expect to have write access to your repository.

I also updated the change log and version as directed by the contributions guide, but if that is something that you prefer to mange I can remove that from this pull request.

I can also attach my test file which may help you see how this can be used in TypeScript with Jest. The test file is just for reference since I did not add TypeScript to your package dependencies, since that seemed like too much of a change.
satellite.test.ts.txt

Let me know what you think.
Thanks, Kyle

Kyle Maxwell added 3 commits August 25, 2020 15:23
Adds interface definitions for TypeScript to allow code to be
used in TypeScript modules.
@ezze ezze merged commit 9368ed5 into shashwatak:develop Sep 14, 2020
@ezze
Copy link
Collaborator

ezze commented Sep 14, 2020

@kylegmaxwell, thanks for your contribution. Try it out in 4.1.0.

@kylegmaxwell
Copy link
Author

I tried it out with 4.1.1 and it works great for our use case, thanks for accepting it and catching those documentation updates.

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

Successfully merging this pull request may close these issues.

2 participants