Документація: функція getDictionaryAsync в intlayer

Опис

Функція getDictionaryAsync завантажує один локальний чанк словника та повертає його інтерпретований вміст.

Вона є аналогом getDictionary для карт завантажувачів для кожної локалі, виданих в .intlayer/dynamic_dictionaries/: замість отримання словника, який містить кожну локаль, вона отримує карту завантажувачів та чекає лише на чанк потрібної локалі.

У коді застосунку ви зазвичай викликаєте getIntlayerAsync, а не цю функцію. Плагіни збирання переписують кожний виклик getIntlayerAsync('key', locale) на getDictionaryAsync(loaderMap, 'key', locale). getDictionaryAsync експортується для користувацьких завантажувачів та для утиліт, які будують власні карти завантажувачів.

Ключові можливості:

• Завантажує лише потрібний локальний чанк
• Підтримує звичайні (locale → loader) та кваліфіковані (locale → qualifierId → loader) карти завантажувачів
• Дедублікує одночасне завантаження одного чанка та кешує розв'язаний вміст
• Невдалі завантаження видаляються з кешу, так що пізніший виклик повторює спробу чанка

Сигнатура функції

getDictionaryAsync(
  dictionaryLoaders: PlainDynamicLoaderMap | QualifiedDynamicLoaderMap, // Обов'язково
  key: string,                                           // Обов'язково
  localeOrSelector?: LocalesValues | DictionarySelector, // Опціонально
  plugins?: Plugins[]                                    // Опціонально
): Promise<DeepTransformContent<...>>

Параметри

• dictionaryLoaders: PlainDynamicLoaderMap | QualifiedDynamicLoaderMap

  • Опис: Карта завантажувачів для кожної локалі. Звичайні карти асоціюють локаль із завантажувачем; кваліфіковані карти (використовуються колекціями та варіантами) асоціюють локаль із ідентифікатором кваліфікатора, а потім із завантажувачем. Для кваліфікованої карти завантажуються лише chunk'и, на які спрямований селектор.
  • Тип: PlainDynamicLoaderMap<T> | QualifiedDynamicLoaderMap
  • Обов'язковий: Так

• key: string

  • Опис: Ключ словника, використовується для namespace'ування кешу chunk'ів.
  • Тип: string
  • Обов'язковий: Так

• localeOrSelector: LocalesValues | DictionarySelector

  • Опис: Локаль для інтерпретації вмісту або об'єкт селектора ({ item }, { variant }, необов'язково з locale). Див. динамічні словники.
  • Тип: LocalesValues | DictionarySelector
  • Обов'язковий: Ні (опціонально), за замовчуванням встановлюється значення defaultLocale.

• plugins: Plugins[]

  • Опис: Трансформатори Node. За замовчуванням використовується базовий набір інтерпретаторів.
  • Тип: Plugins[]
  • Обов'язковий: Ні (опціонально)

Значення, що повертається

• Тип: Promise<Content>, проміс, що повертає інтерпретований вміст завантаженого чанка.
• Опис: Повертає null, коли карта не надає чанка для запитаної локалі або будь-якого з її запасних варіантів (fallbacks), аналогічно до того, як обробляється відсутня кваліфікована координата.

Приклад використання

З генерованою картою завантажувача

import { getDictionaryAsync } from "intlayer";
import appLoaderMap from "../.intlayer/dynamic_dictionaries/app";

const { title } = await getDictionaryAsync(appLoaderMap, "app", "fr");

З користувацькою картою завантажувача

import { getDictionaryAsync } from "intlayer";

const loaderMap = {
  en: () => import("./banner.en.json").then((mod) => mod.default),
  fr: () => import("./banner.fr.json").then((mod) => mod.default),
};

const banner = await getDictionaryAsync(loaderMap, "banner", "fr");

З селектором на кваліфікованій карті

import { getDictionaryAsync } from "intlayer";

const promoBanner = await getDictionaryAsync(bannerLoaderMap, "banner", {
  variant: "black-friday",
  locale: "fr",
});

Примітки щодо поведінки

Кешування та дедублікація

Кеш зберігає promise кожної комбінації key + locale + selector, тому одночасні виклики для одного чанку очікують одного завантаження. Відхилене завантаження видаляється з кешу, тому невдалий чанк повторно завантажується при наступному виклику замість того, щоб постійно відтворювати ту саму помилку.

Fallback за локаллю

Звичайна карта завантажувача проходить по тому ж ланцюжку fallback, що й синхронний режим: спочатку запитана локаль, потім її fallback, потім null, якщо жоден з них не видав chunk.

Пов'язані функції

TypeScript

function getDictionaryAsync<
  const T extends Dictionary,
  const A extends LocalesValues | DictionarySelector = DeclaredLocales,
>(
  dictionaryLoaders: PlainDynamicLoaderMap<T> | QualifiedDynamicLoaderMap,
  key: string,
  localeOrSelector?: A,
  plugins?: Plugins[]
): Promise<
  DeepTransformContent<
    T["content"],
    IInterpreterPluginState,
    ExtractSelectorLocale<A>
  >
>;