Documentation : Fonction getIntlayerAsync dans intlayer

Description

La fonction getIntlayerAsync sélectionne un dictionnaire par sa clé et résout son contenu pour une locale donnée, en chargeant cette locale seule.

C'est l'équivalent asynchrone de getIntlayer, destiné aux endroits où un dictionnaire est lu en dehors du rendu — constructeurs de head / métadonnées de route, loaders, fonctions serveur.

Où getIntlayer récupère le dictionnaire fusionné contenant chaque locale, les plugins de build (@intlayer/babel, @intlayer/swc) réécrivent cet appel en getDictionaryAsync(loaderMap, key, locale), le pointant vers les chunks par locale dans .intlayer/dynamic_dictionaries/. Le bundle ne porte donc que la locale réellement demandée.

Sans ces plugins — une build non optimisée — l'appel se résout à travers le registre de dictionnaire synchrone à la place : le même contenu, sans la division par locale.

Fonctionnalités clés :

• Mêmes clés typées, sélecteurs et contenu retourné que getIntlayer
• Charge uniquement le chunk de la locale demandée dans les builds optimisées
• Les appels concurrents pour le même chunk partagent un seul chargement
• Sûr à utiliser dans les constructeurs de métadonnées async, loaders et fonctions serveur

Signature de fonction

getIntlayerAsync(
  key: DictionaryKeys,                        // Requis
  localeOrSelector?: LocalesValues | DictionarySelector, // Optionnel
  plugins?: Plugins[]                         // Optionnel
): Promise<DeepTransformContent<...>>

Paramètres

• key: DictionaryKeys

  • Description: La clé du dictionnaire à lire, telle que déclarée dans vos fichiers de contenu.
  • Type: DictionaryKeys — une union de chaque clé de dictionnaire déclarée.
  • Required: Yes

• localeOrSelector: LocalesValues | DictionarySelector

  • Description: La locale pour interpréter le contenu avec, ou un objet sélecteur pour les dictionnaires dynamiques.
    • 'fr' — une locale
    • { item: 2 } — un élément de collection (omettez item pour obtenir chaque élément en tant que tableau)
    • { variant: 'black-friday' } — une variante nommée (omettez pour celle par default)
    • { variant: { id: 'prod_abc', userId: '123' } } — une variante structurée
    • N'importe quel sélecteur peut porter une locale: { item: 2, locale: 'fr' }
  • Type: LocalesValues | DictionarySelector
  • Required: No (Optional) — defaults to the configured defaultLocale.

• plugins: Plugins[]

  • Description: Des transformateurs de nœuds personnalisés remplaçant les plugins d'interpréteur de base. Utilisation avancée uniquement.
  • Type: Plugins[]
  • Required: No (Optional)

Retours

• Type: Promise<Content> — une promise qui se résout avec le contenu interprété du dictionnaire, typé à partir de votre déclaration.

Exemple d'utilisation

Utilisation de base

import { getIntlayerAsync } from "intlayer";

const { title } = await getIntlayerAsync("app", "fr"); // "Bonjour"

getIntlayer vs getIntlayerAsync

Both accept the same arguments and return the same content: switching from one to the other only changes when and how much is loaded.

Fonctions Associées

• getIntlayer: Équivalent synchrone lisant le dictionnaire fusionné.
• getDictionaryAsync: La fonction de bas niveau que les plugins de build réécrivent dans cet appel.
• getLocale: Détecte la locale d'une requête entrante.

TypeScript

function getIntlayerAsync<
  const T extends DictionaryKeys,
  const A extends LocalesValues | DictionarySelector = DeclaredLocales,
>(
  key: T,
  localeOrSelector?: A,
  plugins?: Plugins[]
): Promise<
  DeepTransformContent<
    DictionaryRegistryResult<T, A>,
    IInterpreterPluginState,
    ExtractSelectorLocale<A>
  >
>;