docs: update README to help sveltekit + TS users #538
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 there! I'm using this library with SvelteKit and ran into some issues after I followed the instructions in the README to set up types for the events. The language server started complaining that it could not find type declarations for things like
./$types
or$lib/....
. It turns out that the Typescript does not allow "extending" of theinclude
key and adding aninclude
element at the roottsconfig.json
resulted in the ts compiler not knowing about the types that sveltekit declares. Thankfully this is easily solved by using sveltekit's function to modify the generated config rather than editing the root config.I just threw this in the readme for now, but happy to move it to where ever you feel is more appropriate.