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 | Localidade de origem. |
localidade | 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 do cache. |
origin | string | Origem encaminhada em solicitações do lado do servidor. |
Métodos de motor
t(text, options?)
Traduzir uma string e retornar o valor resolvido.
setLocale(locale)
Altere o local de destino.
getLocale()
Leia o local de destino atual.
getStore()
Acesse o repositório de tradução subjacente.
TranslationStore
engine.getStore() expõe a máquina de estados de execução de nível mais baixo. O store é o responsável pelo estado de locale,
configuração, traduções hidratadas, strings de origem lembradas e estado de carregamento bloqueante.
Métodos comuns:
| Método | Notas |
|---|---|
obterEstado() | Leia a localidade atualmente selecionada, a localidade definida, a configuração e as traduções em cache. |
hidratar(input) | Mescle as traduções e a configuração na store. Útil para SSR ou bootstrap personalizado. |
dehydrate() | Gere um snapshot da store em um payload de hidratação amigável para merge. |
carregarConfiguração() | Busque os locais aceitos e a configuração de fallback uma vez e, então, armazene o resultado em cache. |
setLocale(locale) | Inicie uma transição de localidade dentro da loja. |
getTranslationSync(input) | Leitura síncrona que retorna um valor pronto ou uma leitura pendente com um valor de fallback. |
obterTradução(entrada) | Leitura de tradução assíncrona que se resolve na string final traduzida. |
estáCarregando(input?) | Retorna verdadeiro quando ainda há trabalho de tradução bloqueante pendente, globalmente ou para um contexto. |
aguardarInatividade(input?) | É resolvido quando o trabalho de tradução bloqueante se estabiliza. Passe timeoutMs para parar de esperar após um prazo, enquanto o carregamento continua em segundo plano. |
getIdleState(input?) | Devolve o estado de espera por tempo esgotado pertencente à loja usado por renderizadores: {timedOut, promise}. |
montar(entry) / desmontar(entry) | Rastreamento opcional de montagens para integrações que ativam a coleta de lixo ciente de montagens. |
Se você estiver usando @18ways/core diretamente, você geralmente fica no nível de engine.t(...). Use a store quando estiver criando seu próprio runtime de renderização ou camada de hidratação.
t() opções
| Opção | Tipo | Notas |
|---|---|---|
localidade | string | Substitua o local de destino para esta chamada. |
baseLocale | string | Substitua o local padrão para esta chamada. |
contexto | string | objeto | Substitua o contexto para esta chamada. |
vars | Registro<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, mas o motor deve ser o ponto de partida padrão.