docs(env): mention vite/client.d.ts #5457
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
Shinigami92
reviewed
Oct 28, 2021
Shinigami92
added
documentation
Co-authored-by: Shinigami <chrissi92@hotmail.de>
Co-authored-by: Shinigami <chrissi92@hotmail.de>
bluwy
reviewed
Oct 28, 2021
bluwy
reviewed
Oct 29, 2021
docs/guide/env-and-mode.md
Outdated
Comment on lines
58
to
62
| By default, Vite provides type definition for `import.meta.env` in [`vite/client.d.ts`](https://github.com/vitejs/vite/blob/main/packages/vite/client.d.ts). Make sure to reference it in your project, for instance in `src/env.d.ts` | ||
|
|
||
| ```typescript | ||
| /// <reference types="vite/client" /> | ||
| ``` |
There was a problem hiding this comment.
I just realized that the docs below this change had also mentioned about env.d.ts, which makes this part a bit out of place. I wonder if it would suffice to only add the /// <reference types="vite/client" /> in the code block below (line 69) to simplify the docs, and revert most of the text changes.
There was a problem hiding this comment.
Great, that's much simpler now. I've updated the PR.
simon04
changed the title
bluwy
approved these changes
Oct 29, 2021
Shinigami92
approved these changes
Oct 29, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Description
Mention
compilerOptions.typesin https://vitejs.dev/guide/env-and-mode.htmlAdditional context
What is the purpose of this pull request?
Before submitting the PR, please make sure you do the following
fixes #123).