Dokumentation: getDictionary-Funktion in intlayer

Beschreibung

Die Funktion getDictionary interpretiert ein Dictionary-Objekt, das Sie selbst übergeben, und gibt seinen aufgelösten Inhalt für ein bestimmtes Locale zurück. Sie durchläuft den Inhalt in einem einzigen Durchgang und wendet bei Bedarf jedes Interpreter-Plugin an, wobei t()-Übersetzungen, Enumerationen, Bedingungen, Einfügungen, Verschachtelung, Markdown, HTML und Datei-Knoten aufgelöst werden.

Im Gegensatz zu getIntlayer, das ein Dictionary anhand eines Schlüssels in der generierten Registry nachschlägt, nimmt getDictionary das Dictionary selbst entgegen. Dies macht es zum richtigen Werkzeug für Inhalte, die zur Laufzeit erstellt, von einer API oder einem CMS abgerufen oder inline in einem Test deklariert werden.

Hauptfunktionen:

• Funktioniert mit jedem Objekt, das der Dictionary-Struktur folgt ({ key, content })
• Akzeptiert auch eine qualifizierte Dictionary-Gruppe (Collections, Varianten) zusammen mit einem Selector
• Vollständig typisiert: Das zurückgegebene Objekt spiegelt den content wider, den Sie übergeben haben
• Akzeptiert benutzerdefinierte Interpreter-Plugins

Funktionssignatur

getDictionary(
  dictionary: Dictionary | QualifiedDictionaryGroup, // Erforderlich
  localeOrSelector?: LocalesValues | DictionarySelector, // Optional
  plugins?: Plugins[]                                // Optional
): DeepTransformContent<...>

Parameter

• dictionary: Dictionary | QualifiedDictionaryGroup

  • Beschreibung: Das zu interpretierende Wörterbuch (oder die qualifizierte Wörterbuchgruppe).
  • Typ: Dictionary | QualifiedDictionaryGroup
  • Erforderlich: Ja

• localeOrSelector: LocalesValues | DictionarySelector

  • Beschreibung: Das Locale zur Interpretation des Inhalts oder ein Selector-Objekt ({ item }, { variant }, optional mit locale). Siehe dynamische Wörterbücher.
  • Typ: LocalesValues | DictionarySelector
  • Erforderlich: Nein (Optional) — wird standardmäßig auf das konfigurierte defaultLocale gesetzt.

• plugins: Plugins[]

  • Beschreibung: Ein Array von Node-Transformern, die definieren, wie erkannte Knoten interpretiert werden. Wenn weggelassen, wird der Standard-Satz von Interpreter-Plugins verwendet.
  • Typ: Plugins[]
  • Erforderlich: Nein (Optional)

Rückgabewerte

• Typ: Der interpretierte Inhalt des Wörterbuchs.
• Beschreibung: Der content, den Sie übergeben haben, mit jedem aufgelösten Intlayer-Knoten für das angeforderte Gebietsschema. Für eine Sammlungsgruppe ohne einen item-Selector wird ein geordnetes Array interpretierter Einträge zurückgegeben; null wird zurückgegeben, wenn der Selector nichts anvisiert.

Beispielverwendung

Grundlegende Verwendung

import { getDictionary, t } from "intlayer";

const content = getDictionary(
  {
    key: "my_key",
    content: {
      greeting: t({
        de: "Hallo",
        en: "Hello",
        fr: "Bonjour",
      }),
    },
  },
  "de"
);

console.log(content.greeting); // "Hallo"

Interpretation von zur Laufzeit abgerufenem Inhalt

import { getDictionary, type Dictionary } from "intlayer";

const remoteDictionary: Dictionary = await fetch("/api/cms/banner").then(
  (res) => res.json()
);

const banner = getDictionary(remoteDictionary, "fr");

Mit einem Selector

import { getDictionary } from "intlayer";

// Eine qualifizierte Wörterbuchgruppe wird in einen einzelnen Eintrag aufgelöst…
const secondItem = getDictionary(blogPostGroup, { item: 2, locale: "fr" });

// …oder in ein geordnetes Array, wenn kein `item` angegeben wird
const allItems = getDictionary(blogPostGroup, { locale: "fr" });

Verwandte Funktionen

• getIntlayer: Gleiche Interpretation, aber das Dictionary wird nach Schlüssel in der generierten Registry gesucht.
• getDictionaryAsync: Gegenstück für Pro-Locale-Loader-Maps.
• useDictionary: Das React Hook-Äquivalent, das das Locale vom Provider ausliest.

TypeScript

function getDictionary<
  const T extends Dictionary | QualifiedDictionaryGroup,
  const A extends LocalesValues | DictionarySelector = DeclaredLocales,
>(
  dictionary: T,
  localeOrSelector?: A,
  plugins?: Plugins[]
): DeepTransformContent<
  ResolveQualifiedDictionaryContent<T, A>,
  IInterpreterPluginState,
  ExtractSelectorLocale<A>
>;