chore: improve astro:env docs #11653
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: 56b72df The changes in this PR will be included in the next version bump. 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 |
github-actions
bot
added
pkg: astro
florian-lefebvre
commented
Aug 8, 2024
| * | ||
| * The `astro:env` API lets you configure a type-safe schema for your environment variables, and indicate whether they should be available on the server or the client. Import and use your defined variables from the appropriate `/client` or `/server` module: | ||
| * | ||
| * ```astro | ||
| * --- | ||
| * import { APP_ID } from "astro:env/client" | ||
| * import { API_URL, API_TOKEN, getSecret } from "astro:env/server" | ||
| * const NODE_ENV = getSecret("NODE_ENV") |
There was a problem hiding this comment.
Removes getSecret from the first snippet so that people do not assume it's the only way to access them (+ it's an advanced uscase)
| * }) | ||
| * --- | ||
| * | ||
| * <script> | ||
| * import { API_URL } from "astro:env/client" |
There was a problem hiding this comment.
Also showing in a client script so users understand a client var can be accessed on both client and server
sarah11918
approved these changes
Aug 8, 2024
Co-authored-by: Sarah Rainsberger <[email protected]>
Merged
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.
Changes
N/A
Testing
N/A
Docs
Yes