Add typescript definition for public API. #89
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, I use this project with a project written in typescript so I made a typescript definition for it.
If you're not familiar with typescript there's two approaches to adding a public definition file. The preferred approach is to add it to the project and ship with it. This way new changes to the API can be kept in sync. The second approach is that this definition can be shipped as a separate node module and maintained by the typescript community at https://github.com/DefinitelyTyped/DefinitelyTyped
If you're not interested in accepting this PR then please let me know and I'll take the community driven approach instead. If you are, and would like help maintaining the typescript definition when the public API changes, I'm willing to do so.