[docs] enhance docs on adding types to app.d.ts #5280
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 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 |
gtm-nayan
reviewed
Jun 26, 2022
Co-authored-by: gtmnayan <50981692+gtm-nayan@users.noreply.github.com>
benmccann
approved these changes
Jun 26, 2022
chientrm
approved these changes
Jun 27, 2022
This was referenced Jun 27, 2022
avarun42
reviewed
Jun 27, 2022
Comment on lines
+29
to
+42
| * 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.
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.
Problem is that it's a type error if there are no imports, so unfortunately we can't add it by default
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
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 testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. All changesets should bepatchuntil SvelteKit 1.0