Referência de Vanilla JS
create18waysEngine(options)
Importar de @18ways/core/engine.
import { create18waysEngine } from '@18ways/core/engine';Opções comuns:
| Opção | Tipo | Notas |
|---|---|---|
apiKey | string | Obrigatório. |
baseLocale | string | Localização de origem. |
localização | string | Localidade alvo atual. |
contexto | string | objeto | Chave de contexto padrão. |
initialTranslations | Traduções | Cache inicial opcional. |
apiUrl | string | Substituição opcional da base da API. |
fetcher | typeof fetch | Implementação de busca personalizada. |
cacheTtlSeconds | número | Solicitar TTL de cache. |
origin | string | Origem encaminhada em pedidos do lado do servidor. |
Métodos de motor
t(text, options?)
Traduzir uma string e devolver o valor resolvido.
setLocale(locale)
Mude a localidade de destino.
getLocale()
Leia a localidade-alvo atual.
getStore()
Aceda ao repositório de tradução subjacente.
TranslationStore
engine.getStore() expõe a máquina de estados de runtime de nível inferior. A store é dona do estado de locale,
configuração, traduções hidratadas, strings de origem memorizadas e do estado de carregamento bloqueante.
Métodos comuns:
| Método | Notas |
|---|---|
obterEstado() | Ler a localidade atualmente selecionada, a localidade definida, a configuração e as traduções em cache. |
hidratar(input) | Fundir traduções e configuração na store. Útil para SSR ou bootstrapping personalizado. |
desidratar() | Faça um snapshot da loja num payload de hidratação compatível com merge. |
carregarConfiguração() | Obter os locais aceites e a configuração de fallback uma única vez, depois guardar o resultado em cache. |
definirLocalidade(localidade) | Inicie uma transição de idioma dentro da loja. |
obterTraduçãoSincrona(input) | Leitura síncrona que devolve ou um valor já disponível ou uma leitura pendente com um valor de recurso. |
getTranslation(input) | Leitura de tradução assíncrona que resolve para a cadeia de texto traduzida final. |
isLoading(input?) | Devolve true quando ainda existe trabalho de tradução em bloqueio pendente, globalmente ou para um contexto. |
aguardarInatividade(input?) | Resolve-se quando o trabalho de tradução bloqueante termina. Passe timeoutMs para deixar de aguardar após um prazo, enquanto o carregamento continua em segundo plano. |
getIdleState(input?) | Devolve o estado de espera temporizada detido pela loja, usado pelos renderizadores: {timedOut, promise}. |
montar(entry) / desmontar(entry) | Acompanhamento opcional de montagens para integrações que ativam a recolha de lixo com consciência das montagens. |
Se estiveres a usar @18ways/core diretamente, normalmente ficas ao nível de engine.t(...). Recorre ao
store quando estiveres a construir o teu próprio runtime de renderização ou camada de hidratação.
t() opções
| Opção | Tipo | Notas |
|---|---|---|
localização | string | Substitua a localidade de destino para esta chamada. |
baseLocale | string | Substitua a localidade base para esta chamada. |
contexto | string | objeto | Substitua o contexto para esta chamada. |
vars | Record<string, desconhecido> | Entrada variável para waysParser. |
Utility exports
O pacote principal também exporta auxiliares de nível inferior, como:
fetchAcceptedLocalesfetchConfig- utilitários de localidade
Use-os quando precisar deles, mas o motor deve ser o ponto de partida padrão.