Référence Vanilla JS
create18waysEngine(options)
Importer depuis @18ways/core/engine.
import { create18waysEngine } from '@18ways/core/engine';Options courantes :
| Option | Type | Remarques |
|---|---|---|
apiKey | chaîne | Requis. |
baseLocale | chaîne | Locale source. |
locale | chaîne | Locale cible actuel. |
contexte | chaîne | objet | Clé de contexte par défaut. |
initialTranslations | Traductions | Cache de démarrage optionnelle. |
apiUrl | chaîne | Surcharge de base API optionnelle. |
fetcher | typeof fetch | Implémentation de récupération personnalisée. |
cacheTtlSeconds | nombre | Demander le TTL du cache. |
origin | chaîne | Origine transférée sur les requêtes côté serveur. |
Méthodes de moteur
t(text, options?)
Traduisez une chaîne et renvoyez la valeur résolue.
setLocale(locale)
Changer la locale cible.
getLocale()
Lisez la locale cible actuelle.
getStore()
Accédez au magasin de traduction sous-jacent.
TranslationStore
engine.getStore() expose la machine d’état d’exécution de bas niveau. Le store possède l’état de locale,
la configuration, les traductions hydratées, les chaînes source mémorisées et l’état de chargement bloquant.
Méthodes courantes :
| Méthode | Remarques |
|---|---|
getState() | Lire la locale actuellement sélectionnée, la locale définie, la configuration et les traductions en cache. |
hydrate(input) | Fusionnez les traductions et la configuration dans le store. Utile pour le SSR ou un amorçage personnalisé. |
déshydrater() | Faites un instantané du magasin dans une charge utile d’hydratation compatible avec les fusions. |
loadConfig() | Récupérez les paramètres régionaux acceptés et la configuration de repli une seule fois, puis mettez le résultat en cache. |
définirLocale(locale) | Démarrez une transition de langue dans la boutique. |
getTranslationSync(input) | Lecture synchrone qui renvoie soit une valeur prête, soit une lecture en attente avec une valeur de repli. |
getTranslation(input) | Lecture de traduction asynchrone qui résout la chaîne traduite finale. |
estEnChargement(input ?) | Renvoie true lorsqu’un travail de traduction bloquant est encore en attente, globalement ou pour un contexte. |
attendre l’inactivité(input ?) | Se résout lorsque le travail de traduction bloquant se termine. Passez timeoutMs pour cesser d’attendre après un délai, tandis que le chargement se poursuit en arrière-plan. |
getIdleState(input ?) | Renvoie l’état d’attente temporisé détenu par le magasin et utilisé par les moteurs de rendu : {timedOut, promise}. |
monter(entry) / démonter(entry) | Suivi de montage facultatif pour les intégrations qui activent le ramasse-miettes sensible aux points de montage. |
Si vous utilisez directement @18ways/core, vous restez généralement au niveau de engine.t(...). Faites appel au store lorsque vous construisez votre propre runtime de rendu ou votre couche d’hydratation.
t() options
| Option | Type | Remarques |
|---|---|---|
locale | chaîne | Remplacer la locale cible pour cet appel. |
baseLocale | chaîne | Remplacer la locale de base pour cet appel. |
contexte | chaîne | objet | Remplacer le contexte pour cet appel. |
vars | Enregistrement<chaîne, inconnu> | Entrée variable pour waysParser. |
Utility exports
Le package principal exporte également des helpers de niveau inférieur tels que :
fetchAcceptedLocalesfetchConfig- utilitaires de localisation
Utilisez-les lorsque vous en avez besoin, mais le moteur doit être le point de départ par défaut.