Übersetzungsschlüssel typisieren

In einer typsicheren i18n-Konfiguration wird die Menge der gültigen Übersetzungsschlüssel aus Ihrem Nachrichtenobjekt abgeleitet. Ein Tippfehler wie t("greetng") führt dadurch zu einem Compilefehler und nicht zu einem Fehler wegen einer fehlenden Zeichenkette zur Laufzeit.

Beginnen Sie mit einem einfachen Objekt aus Nachrichten. Es ist die einzige Quelle der Wahrheit sowohl für die Werte als auch für den Schlüsseltyp.

Bei einem flachen Objekt liefert keyof typeof die Vereinigung seiner Schlüssel.

Nachrichtenkataloge sind in der Praxis verschachtelt. Wir möchten Pfade mit Punkten wie "cart.empty" und nicht nur Schlüssel der obersten Ebene. Dafür benötigen wir einen rekursiven Typ, der das Objekt durchläuft.

Ein Conditional Type in Kombination mit einem Mapped Type erstellt durch Rekursion in verschachtelte Objekte Pfade mit Punkten und stellt den Schlüsseln Präfixe voran. Das Präfix verwendet einen Template-Literal-Typ, der im echten Code mit Backticks als [backtick]${K}.${Paths<T[K]>}[backtick] geschrieben wird. Zur besseren Lesbarkeit der Auflistung zeigen wir ihn weiter unten als JoinPath(K, child).

Wenn Sie den Nachrichtentyp an Paths übergeben, erhalten Sie jeden gültigen Pfad mit Punkten.

Oft benötigen Sie nur die Blattpfade (die tatsächlichen Zeichenketten), ohne Zwischenobjekte. Passen Sie die Rekursion so an, dass nicht auf Zeichenketten abbildende Knoten übersprungen werden. Das Präfix aus K, Punkt und Unterpfad verwendet wieder einen Template-Literal-Typ (im echten Code mit Backticks begrenzt), der hier als JoinPath dargestellt wird.

Beschränken Sie den Parameter der Übersetzungsfunktion auf die abgeleitete Schlüsselvereinigung, damit nur gültige Schlüssel kompiliert werden.

Sie können noch weitergehen und den Werttyp an einem Pfad ableiten. Das ist nützlich, wenn Nachrichten auch Einträge enthalten, die keine Zeichenketten sind. Ein Conditional Type zur Pfadindizierung durchläuft die Punkte. Er teilt den Pfad mithilfe eines Template-Literal-Musters auf, das im echten Code mit Backticks als Form Head Punkt Rest mit infer geschrieben wird. Diese Aufteilung bezeichnen wir weiter unten als SplitHead/SplitRest.

Ohne as const werden Zeichenkettenwerte zu string erweitert, und Sie verlieren die später benötigten Literalinformationen, zum Beispiel zum Extrahieren von Platzhaltern. Deklarieren Sie Kataloge immer als const.

Wenn Sie die Schlüssel aus dem Katalog ableiten, wird der erlaubte Schlüsseltyp überall sofort aktualisiert, sobald Sie eine Nachricht hinzufügen, umbenennen oder entfernen. Sie müssen kein zentrales Enum pflegen und sich nicht um veraltete Zeichenkettenkonstanten kümmern.

Überprüfen Sie Ihr Verständnis der Typisierung von Übersetzungsschlüsseln.

Sie haben mithilfe von keyof und einem rekursiven Template-Literal-Pfadtyp eine Vereinigung gültiger Schlüssel aus einem messages-Objekt abgeleitet. Varianten, die nur Blattpfade berücksichtigen, schließen Zwischenobjekte aus, ein typisiertes t lehnt ungültige Schlüssel ab, und as const bewahrt die Literalinformationen, die die Typmechanismen benötigen.