docs: add note about runtime config serialization (#8432)

Co-authored-by: Daniel Roe <daniel@roe.dev>
This commit is contained in:
Nils 2022-10-24 10:43:26 +02:00 committed by GitHub
parent 6bcd9cdeb1
commit 7b20e13c85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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).