docs: add information about TypeScript #272
Closed
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.
What:
Added explicit information about TypeScript in the README as well as a note about adding
dom
to the consumertsconfig.json
.Why:
Since starting to use TypeScript, I've found it frustrating when packages I use do not have any information about TypeScript in their README as I have to go hunting. I also encountered the configuration issue outlined in the new documentation. It was hard to track down exactly why I was getting errors, so I thought it would be nice to have it right there.
Checklist: