Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.

docs: add note about runtime config serialization #8432

Merged
pi0 merged 7 commits into from
Oct 24, 2022
Merged

docs: add note about runtime config serialization #8432

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ac08ac6
docs: add note about de/-serializability of runtime config
BracketJohn Oct 24, 2022
607d227
docs: clarify position of configs
BracketJohn Oct 24, 2022
04ebe59
docs: fix dash placement + add paragraph
BracketJohn Oct 24, 2022
93ee10d
docs: trim trailing whitespace
BracketJohn Oct 24, 2022
b08995a
docs: more clearly state what cannot be correctly passed down
BracketJohn Oct 24, 2022
7586e1d
docs: more clearly describe alternative
BracketJohn Oct 24, 2022
6cf48ca
Merge branch 'main' into document_runtimeConfig_deserialization
BracketJohn Oct 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/content/2.guide/4.going-further/10.runtime-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ console.log(runtimeConfig.public.apiBase)
When using Options API the public runtime config is available via `this.$config.public`.
::

### Serialization

Your runtime config will be serialized before being passed to Nitro. This means that anything that cannot be serialized and then deserialized (such as functions, Sets, Maps, and so on), should not be set in your `nuxt.config`.

Instead of passing non-serializable objects or functions into your application from your `nuxt.config`, you can place this code in a Nuxt or Nitro plugin or middleware.

### Environment Variables

The most common way to provide configuration is by using [Environment Variables](https://medium.com/chingu/an-introduction-to-environment-variables-and-how-to-use-them-f602f66d15fa).
Expand Down