Typbestämning av översättningsnycklar

I en typsäker i18n-konfiguration härleds mängden giltiga översättningsnycklar från ert meddelandeobjekt. Ett skrivfel som t("greetng") blir ett kompileringsfel i stället för ett fel med en saknad sträng vid körning.

Börja med ett vanligt objekt med meddelanden. Det är den enda källan till sanning för både värdena och nyckeltypen.

För ett platt objekt ger keyof typeof unionen av nycklarna.

Verkliga meddelandekataloger är nästlade. Vi vill ha punktseparerade sökvägar som "cart.empty", inte bara nycklar på toppnivå. Vi behöver en rekursiv typ som går igenom objektet.

En villkorstyp tillsammans med en mappad typ bygger punktseparerade sökvägar genom att rekursivt gå in i nästlade objekt och lägga till prefix framför nycklarna. Prefixet använder en template literal-typ, som i riktig kod skrivs med backticks som [backtick]${K}.${Paths<T[K]>}[backtick]. Nedan visar vi den som JoinPath(K, child) för att hålla kodexemplet rent.

När meddelandetypen skickas till Paths erhålls alla giltiga punktseparerade nycklar.

Ofta vill ni bara ha löv-sökvägarna, alltså de faktiska strängarna, och utesluta mellanliggande objekt. Justera rekursionen så att noder som inte är strängar hoppas över. Prefixet med K, punkt och underordnad sökväg använder återigen en template literal-typ, som i riktig kod avgränsas med backticks och här visas som JoinPath.

Begränsa översättningsfunktionens parameter till den härledda nyckelunionen så att endast giltiga nycklar kan kompileras.

Ni kan gå ett steg längre och härleda värdetypen vid en sökväg, vilket är användbart när meddelanden innehåller poster som inte är strängar. En villkorstyp som indexerar sökvägar går igenom punkterna. Den delar upp sökvägen med ett template literal-mönster som i riktig kod skrivs med backticks som formen Head punkt Rest med infer. Nedan betecknar vi den uppdelningen som SplitHead/SplitRest.

Utan as const breddas strängvärden till string, och ni förlorar den literalinformation som behövs senare, till exempel för att hitta platshållare. Deklarera alltid kataloger som const.

Att härleda nycklar från katalogen innebär att en tillagd, omdöpt eller borttagen meddelandepost omedelbart uppdaterar den tillåtna nyckeltypen överallt. Ingen central enum att underhålla och inga inaktuella strängkonstanter.

Ni härledde en union av giltiga nycklar från ett messages-objekt med hjälp av keyof och en rekursiv template literal-baserad sökvägstyp. Varianter med endast löv utesluter mellanliggande objekt, en typad t avvisar ogiltiga nycklar, och as const bevarar den literalinformation som typmekanismen behöver.