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

docs: update README to help sveltekit + TS users #538

Merged
merged 3 commits into from
Feb 18, 2024
Merged

docs: update README to help sveltekit + TS users #538

merged 3 commits into from
Feb 18, 2024

Conversation

gurpreetatwal
Copy link
Contributor

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 the include key and adding an include element at the root tsconfig.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.

@isaacHagoel
Copy link
Owner

Thanks for this. Do you mind bumping the version in package.json and updating release-notes.md?

@gurpreetatwal
Copy link
Contributor Author

Done! Apologies that it took that long

@isaacHagoel
Copy link
Owner

Thanks

@isaacHagoel isaacHagoel merged commit abdf5a0 into isaacHagoel:master Feb 18, 2024
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.

2 participants