-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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] enhance docs on adding types to app.d.ts #5280
Conversation
🦋 Changeset detectedLatest commit: 521a417 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Co-authored-by: gtmnayan <50981692+gtm-nayan@users.noreply.github.com>
* Or wrap the namespace with `declare global`: | ||
* ```ts | ||
* import { User } from '$lib/types'; | ||
* | ||
* declare global { | ||
* namespace App { | ||
* interface Locals { | ||
* user: User; | ||
* } | ||
* // ... | ||
* } | ||
* } | ||
* ``` | ||
* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there drawbacks to wrapping the namespace with declare global
? If not, wouldn't it make sense to just do this by default in create-svelte
? And if there are, then it probably shouldn't be recommended without a caveat.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Problem is that it's a type error if there are no imports, so unfortunately we can't add it by default
People still get confused by this too often, I hope this helps resolving their issues around imports quicker.
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm test
and lint the project withpnpm lint
andpnpm check
Changesets
pnpm changeset
and following the prompts. All changesets should bepatch
until SvelteKit 1.0