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 definition for public API. #89

Merged
merged 1 commit into from Oct 2, 2017

Conversation

chriseppstein
Copy link
Collaborator

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.

@coveralls
Copy link

coveralls commented Sep 25, 2017

Coverage Status

Coverage increased (+0.3%) to 98.904% when pulling 3deaac1 on chriseppstein:typescript into 018ae87 on fb55:master.

@chriseppstein
Copy link
Collaborator Author

@fb55 I won't have time to work on a full port to typescript for a few weeks to a month can we land the definition file for now?

@fb55 fb55 merged commit bf8e7b2 into fb55:master Oct 2, 2017
@fb55
Copy link
Owner

fb55 commented Oct 2, 2017

Sure thing :)

@chriseppstein
Copy link
Collaborator Author

@fb55 Thanks! will it be released to npm in the near future?

fb55 pushed a commit that referenced this pull request Oct 21, 2018
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.

None yet

3 participants