Skip to content

docs: add definitely typed requirement#496

Closed
thiagomini wants to merge 1 commit intotesting-library:mainfrom
thiagomini:docs/add-definitely-typed-requirement
Closed

docs: add definitely typed requirement#496
thiagomini wants to merge 1 commit intotesting-library:mainfrom
thiagomini:docs/add-definitely-typed-requirement

Conversation

@thiagomini
Copy link
Copy Markdown

What:
Adds a brief section explaining that the dev should also install the types via DT to be able to use this library with Typescript

Why:
It wasn't obvious to me (and I believe to others) that this library did not come with type definitions out of the box. I thought it was an issue with tsconfig.json, but it was only due to missing the types package.

How:

Added a few lines to the typescript section

Checklist:

  • Documentation
  • Tests
  • Updated Type Definitions
  • Ready to be merged

@github-actions
Copy link
Copy Markdown

🎉 This issue has been resolved in version 6.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant