Documentation: funzione getIntlayerAsync in intlayer

Descrizione

La funzione getIntlayerAsync seleziona un dizionario in base alla sua chiave e risolve il suo contenuto per una determinata locale, caricando solo quella locale.

È l'equivalente asincrono di getIntlayer, destinato ai casi in cui un dizionario viene letto al di fuori del rendering — route head / metadata builders, loaders, server functions.

Dove getIntlayer carica il dizionario unito contenente ogni locale, i build plugins (@intlayer/babel, @intlayer/swc) riscrivono questa chiamata in getDictionaryAsync(loaderMap, key, locale), puntandola ai chunk per-locale in .intlayer/dynamic_dictionaries/. Il bundle quindi contiene solo la locale effettivamente richiesta.

Senza questi plugin — una build non ottimizzata — la chiamata viene risolta attraverso il registro dizionario sincrono invece: lo stesso contenuto, senza la divisione per-locale.

Caratteristiche principali:

• Stesse chiavi tipizzate, selettori e contenuto restituito di getIntlayer
• Carica solo il chunk della locale richiesta nelle build ottimizzate
• Le chiamate concorrenti per lo stesso chunk condividono un singolo caricamento
• Sicuro da usare in async metadata builders, loaders e server functions

Firma della Funzione

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

Parametri

• key: DictionaryKeys

  • Description: La chiave del dizionario da leggere, come dichiarato nei tuoi file di contenuto.
  • Type: DictionaryKeys — un'unione di ogni chiave di dizionario dichiarata.
  • Required: Yes

• localeOrSelector: LocalesValues | DictionarySelector

  • Description: La locale per interpretare il contenuto, o un oggetto selector per dizionari dinamici.
    • 'fr' — una locale
    • { item: 2 } — un elemento di collection (ometti item per ottenere ogni elemento come array)
    • { variant: 'black-friday' } — un variant denominato (ometti per quello default)
    • { variant: { id: 'prod_abc', userId: '123' } } — una variante strutturata
    • Qualsiasi selector può contenere una locale: { item: 2, locale: 'fr' }
  • Type: LocalesValues | DictionarySelector
  • Required: No (Optional) — defaults to the configured defaultLocale.

• plugins: Plugins[]

  • Description: Custom node transformers che sostituiscono i plugin base dell'interprete. Uso avanzato soltanto.
  • Type: Plugins[]
  • Required: No (Optional)

Restituisce

• Type: Promise<Content> — una promise che si risolve nel contenuto interpretato del dizionario, tipizzato dalla tua dichiarazione.

Esempio di utilizzo

Utilizzo di base

import { getIntlayerAsync } from "intlayer";

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

getIntlayer vs getIntlayerAsync

Entrambi accettano gli stessi argomenti e restituiscono lo stesso contenuto: il cambio da uno all'altro cambia solo quando e quanto viene caricato.

Funzioni Correlate

• getIntlayer: Equivalente sincrono che legge il dizionario unito.
• getDictionaryAsync: La funzione di basso livello in cui i plugin di build riscrivono questa chiamata.
• getLocale: Rileva la locale di una richiesta in arrivo.

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>
  >
>;