Configuration sérialisée expérimentale

Type : boolean
Par défaut : false

Ajouté à la version : astro@5.2.0

Cette fonctionnalité permet d’accéder au module virtuel astro:config qui expose une version non exhaustive, sérialisable et assurant la sûreté du typage de la configuration Astro à travers deux sous-modules.

Pour un aperçu complet et pour donner votre avis sur cette API expérimentale, consultez la RFC du manifeste sérialisé.

Pour activer ce module virtuel, ajoutez l’option de fonctionnalité experimental.serializeConfig à votre configuration Astro :

astro.config.mjs

import { defineConfig } from "astro/config"

export default defineConfig({
  experimental: {
    serializeConfig: true
  }
})

Ensuite, les valeurs de configuration peuvent être utilisées par n’importe quel fichier de votre projet Astro :

src/utils.js

import { trailingSlash } from "astro:config/client";

function addForwardSlash(path) {
  if (trailingSlash === "always") {
    return path.endsWith("/") ? path : path + "/"
  } else {
    return path
  }
}

Sous-modules

Titre de la section Sous-modules

Le module virtuel expose deux sous-modules permettant d’accéder à différents sous-ensembles de vos valeurs de configuration. Cela protège vos informations en ne mettant à disposition du client que certaines données.

Toutes les valeurs de configuration disponibles sont accessibles depuis astro:config/server. Cependant, pour le code exécuté côté client, seules les valeurs exposées par astro:config/client seront disponibles.

astro:config/client

Titre de la section astro:config/client

Le sous-module client vous permet d’accéder à un sous-ensemble des valeurs de configuration dans astro:config/server qui peuvent être exposées en toute sécurité au navigateur, telles que trailingSlash, build.format, i18n, etc. Utilisez ce sous-module pour le code côté client qui est exécuté sur le client.

Il s’agit d’une fonctionnalité en cours de développement. Pour obtenir une liste complète et à jour des valeurs de configuration disponibles dans astro:config/client, veuillez consulter l’API proposée dans la RFC de la fonctionnalité

astro:config/server

Titre de la section astro:config/server

Le sous-module serveur vous permet d’accéder à un ensemble non exhaustif de vos valeurs de configuration à partir de astro.config.mjs. Cela inclut les valeurs astro:config/client telles que trailingSlash et i18n, mais également des informations plus sensibles sur la configuration de votre système de fichiers qu’il n’est pas sûr d’exposer au client, telles que srcDir, cacheDir, outDir. Tenter de les utiliser côté client générera une erreur.

Il s’agit d’une fonctionnalité en cours de développement. Pour obtenir une liste complète et à jour des valeurs de configuration disponibles dans astro:config/server, veuillez consulter l’API proposée dans la RFC de la fonctionnalité.