Vanilla JS Referenz
create18waysEngine(options)
Importieren von @18ways/core/engine.
import { create18waysEngine } from '@18ways/core/engine';Allgemeine Optionen:
| Option | Typ | Notizen |
|---|---|---|
apiKey | Zeichenfolge | Erforderlich. |
basisLocale | Zeichenfolge | Quellgebiet. |
lokal | Zeichenfolge | Aktuelle Zielgebietssprache. |
Kontext | string | objekt | Standard-Kontextschlüssel. |
initialTranslations | Übersetzungen | Optionaler Start-Cache. |
apiUrl | Zeichenfolge | Optionale API-Basisüberschreibung. |
fetcher | typeof fetch | Benutzerdefinierte Abrufimplementierung. |
cacheTtlSeconds | nummer | Anforderungs-Cache-TTL. |
origin | Zeichenfolge | Ursprung bei serverseitigen Anfragen weitergeleitet. |
Motor Methoden
t(text, options?)
Übersetzen Sie einen String und geben Sie den aufgelösten Wert zurück.
setLocale(locale)
Ändern Sie die Ziel-Lokalisierung.
getLocale()
Lese die aktuelle Ziel-Lokalisierung.
getStore()
Greifen Sie auf den zugrunde liegenden Übersetzungsspeicher zu.
TranslationStore
engine.getStore() legt die zustandsnahe Laufzeit-Zustandsmaschine offen. Der Store verwaltet den Gebietsschema-Zustand,
Konfiguration, geladene Übersetzungen, gemerkte Quellstrings und einen blockierenden Ladezustand.
Gängige Methoden:
| Methode | Notizen |
|---|---|
getState() | Lesen Sie das aktuell ausgewählte Gebietsschema, das festgelegte Gebietsschema, die Konfiguration und zwischengespeicherte Übersetzungen. |
hydrate(input) | Übersetzungen und Konfiguration in den Store zusammenführen. Nützlich für SSR oder individuelles Bootstrapping. |
dehydrate() | Erstelle einen Snapshot des Stores in ein Merge-kompatibles Hydratations-Payload. |
loadConfig() | Abgerufene akzeptierte Locale und Fallback-Konfiguration einmal ermitteln, dann das Ergebnis zwischenspeichern. |
setLocale(locale) | Starten Sie einen Locale-Wechsel innerhalb des Stores. |
getTranslationSync(input) | Synchrones Lesen, das entweder einen fertigen Wert oder einen ausstehenden Lesevorgang mit einem Fallback-Wert zurückgibt. |
getTranslation(Eingabe) | Asynchrone Übersetzung lesen, das sich in den endgültigen übersetzten String auflöst. |
lädtInput?( ) | Gibt true zurück, wenn blockierende Übersetzungsarbeit noch aussteht, global oder für einen Kontext. |
aufLeerlaufWarten(input?) | Wird behoben, wenn die blockierende Übersetzungsarbeit abgeschlossen ist. Übergib timeoutMs, um das Warten nach einer Frist zu beenden, während das Laden im Hintergrund fortgesetzt wird. |
getIdleState(input?) | Gibt den vom Store besessenen zeitgesteuerten Wartezustand zurück, der von Renderern verwendet wird: {timedOut, promise}. |
mount(entry) / unmount(entry) | Optionale Einhängepunktverfolgung für Integrationen, die einhängepunktbewusste Garbage Collection ermöglichen. |
Wenn du @18ways/core direkt verwendest, bleibst du normalerweise auf der Ebene von engine.t(...). Greife auf
den Store zurück, wenn du deine eigene Rendering-Laufzeit oder Hydrierungsschicht aufbaust.
t() Optionen
| Option | Typ | Notizen |
|---|---|---|
lokal | Zeichenfolge | Überschreiben Sie die Ziel-Lokalisierung für diesen Aufruf. |
basisLocale | Zeichenfolge | Überschreiben Sie die Basislokalisierung für diesen Aufruf. |
Kontext | string | objekt | Überschreiben Sie den Kontext für diesen Anruf. |
variablen | Record<string, unbekannt> | Variable Eingabe für waysParser. |
Utility exports
Das Kernpaket exportiert auch niedrigere Hilfsfunktionen wie:
fetchAcceptedLocalesfetchConfig- Locale-Dienste
Verwenden Sie diese, wenn Sie sie benötigen, aber der Motor sollte der Standard-Ausgangspunkt sein.