La propriété env
Permet de partager des variables d'environnement entre le client et le serveur.
-
Type:
Object
Nuxt nous permet de créer des variables d'environnement côté client et de les partager aussi côté serveur.
La propriété env définit les variables d'environnement qui devraient être disponibles côté client. Elles peuvent être assignées en utilisant les variables d'environnement côté serveur. Pour plus d'informations, voir le module dotenv .
env property with runtimeConfig properties : publicRuntimeOptions and privateRuntimeOptions.
Learn more with our tutorial about moving from @nuxtjs/dotenv to runtime config .
Faites attention de lire à propos de process.env et process.env == {} ci-dessous pour un meilleur débogage.
export default {
env: {
baseUrl: process.env.BASE_URL || 'http://localhost:3000'
}
}
Cela nous permet de créer une propriété baseUrl qui sera égale à la variable d'environment côté serveur nommée BASE_URL si disponible/définie. Sinon, baseUrl côté client sera égale à 'http://localhost:3000'. La variable BASE_URL côté serveur sera ainsi copiée côté client via la propriété env du fichier nuxt.config.js. En dernier recours, la valeur sera égale à 'http://localhost:3000'.
Ensuite, on peut avoir accès à la variable baseUrl de 2 façons:
-
Via
process.env.baseUrl. -
Via
context.env.baseUrl, voir l'API context .
On peut par exemple, utiliser la propriété env pour donner un token public.
Pour l'exemple au dessus, on peut l'utiliser pour configurer axios .
import axios from 'axios'
export default axios.create({
baseURL: process.env.baseUrl
})
Ensuite, dans nos pages, on peut import axios ainsi: import axios from '~/plugins/axios'.
Injection automatique de variables d'environnement
Si on définit des variables d'environnement commençant par un NUXT_ENV_ lors de la phase de build (ex: NUXT_ENV_COOL_WORD=freezing nuxt build), elles seront automatiquement injectées dans le processus de l'environnement. Attention cependant à ne pas oublier que ces variables peuvent écraser des variables du même nom précédemment définies dans le fichier nuxt.config.js.
process.env == {}
Il faut savoir que Nuxt utilise definePlugin de Webpack pour définir les variables d'environnement. Cela veut dire que les process ou process.env de Node.js ne sont ni disponibles ni définis. Chaque propriété d'env définie dans nuxt.config.js est individuellement mappée à un process.env.xxxx et convertie durant la compilation.
Cela veut dire que console.log(process.env) va renvoyer {} mais que console.log(process.env.notre_variable) va tout de même renvoyer notre valeur. Lorsque Webpack compile notre code, il remplace toutes les instances de process.env.your_variable par la valeur qui lui est attribuée.
Exemple: env.test = 'testing123'. Si on utilise process.env.test quelque part dans notre code, cela sera traduit en 'testing123'.
avant
if (process.env.test == 'testing123')
après
if ('testing123' == 'testing123')
serverMiddleware
Comme le serverMiddleware est découplé du build principal de Nuxt, les variables env définies dans le fichier nuxt.config.js n'y seront pas disponibles.
Leoš Literák
Trizotti
Clément Ollivier
Sébastien Chopin
Marcello Bachechi
Rodolphe
Thomas Underwood
Shek Evgeniy
felipesuri
Lukasz Formela
Hugo Torzuoli
Sylvain Marroufin
Kareem Dabbeet
tramplay
Daniel Roe
verebelyicsaba
Adam
Nate Butler
Sandra Rodgers
Arpit Patidar
Matthew Kuehn
Steven DUBOIS
Travis Lindsey
syagawa
Maxime
かる
Al Power
Florent Delerue
quanghm
José Manuel Casani Guerra
Unai Mengual
kazuya kawaguchi
Michael Lynch
Tomachi
pooya parsa
Meir Roth
Brett
Adam Miedema
Thomas Bnt
Kazuki Furukawa
Anthony Ruelle
Christophe Carvalho Vilas-Boas
Roman Harmyder