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 #16

Merged
merged 2 commits into from
Jun 6, 2022
Merged

Add typescript types #16

merged 2 commits into from
Jun 6, 2022

Conversation

antonk52
Copy link
Contributor

Hi and thank you for your work!

It would be great if this package could include typescript definitions which typescript and/or vscode users can leverage.

antonk52 and others added 2 commits May 31, 2022 13:04
* publish `index.d.ts`
* restrict exported types to the public API
* add comments to improve the editor experience

Co-authored-by: Robert Jackson <me@rwjblue.com>
@hjdivad hjdivad requested a review from rwjblue June 3, 2022 20:12
@hjdivad
Copy link
Collaborator

hjdivad commented Jun 3, 2022

@rwjblue see if i missed anything then merge away

@antonk52 thank you very much for the contribution! This is wonderful

@antonk52
Copy link
Contributor Author

antonk52 commented Jun 4, 2022

These's one thing I missed, it is to include index.d.ts in files field in package.json so the types are published to npm alongside with index.js. I will update the PR shortly.
I see you've corrected that already. Thank you!

@rwjblue rwjblue added the enhancement New feature or request label Jun 6, 2022
@rwjblue rwjblue merged commit 01f40dc into rwjblue:main Jun 6, 2022
@antonk52
Copy link
Contributor Author

@hjdivad @rwjblue Can I kindly ask for a new npm release that includes these changes? Please 😅

@hjdivad
Copy link
Collaborator

hjdivad commented Jul 25, 2022

@antonk52 released as 2.1.0

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

Successfully merging this pull request may close these issues.

None yet

3 participants