Skip to content

docs: warn about using different env variables for runtimeConfig#24612

Merged
danielroe merged 5 commits intomainfrom
manniL-patch-1
Dec 5, 2023
Merged

docs: warn about using different env variables for runtimeConfig#24612
danielroe merged 5 commits intomainfrom
manniL-patch-1

Conversation

@TheAlexLichter
Copy link
Copy Markdown
Member

@TheAlexLichter TheAlexLichter commented Dec 5, 2023

❓ Type of change

  • 📖 Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

I've seen the pattern a few times, causing issues during runtime.

export default defineNuxtConfig({
  runtimeConfig: {
    apiSecret: process.env.SOME_OTHER_VALUE, // This will break when trying to set SOME_OTHER_VALUE during runtime
    apiKey: process.env.API_KEY.trim(), // This won't transform values when setting API_KEY during runtime
  },
})

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@nuxt-studio
Copy link
Copy Markdown
Contributor

nuxt-studio bot commented Dec 5, 2023

Live Preview ready!

Name Edit Preview Latest Commit
Nuxt Docs Edit on Studio ↗︎ View Live Preview f8c3dc5

@github-actions github-actions bot added the 3.x label Dec 5, 2023
Copy link
Copy Markdown
Member

@danielroe danielroe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants