Sanggunian sa Vanilla JS

create18waysEngine(options)

Mag-import mula sa @18ways/core/engine.

ts
import { create18waysEngine } from '@18ways/core/engine';

Mga karaniwang opsyon:

OpsyonUriMga Tala
apiKeystringKinakailangan.
baseLocalestringPinagmulan na lokasyon.
lokalidadstringKasalukuyang target na locale.
kontekstostring | objectDefault na context key.
initialTranslationsMga salinOpsyonal na panimulang cache.
apiUrlstringOpsyonal na pag-override sa base ng API.
fetcheruri ng fetchPasadyang pagpapatupad ng fetch.
cacheTtlSecondsnumeroTTL ng request cache.
pinagmulanstringPinasa ang pinagmulan sa mga kahilingang ipinasa sa server.

Mga paraan ng makina

t(text, options?)

Isalin ang isang string at ibalik ang nalutas na halaga.

setLocale(locale)

Palitan ang target na locale.

getLocale()

Basahin ang kasalukuyang target na locale.

getStore()

I-access ang pinagbabatayang imbakan ng salin.

TranslationStore

engine.getStore() ay naglalantad ng mas mababang antas na runtime state machine. Ang store ang may hawak ng locale state, config, hydrated translations, naaalalang source strings, at blocking loading state.

Mga karaniwang paraan:

ParaanMga Tala
getState()Basahin ang kasalukuyang napiling locale, nakatakdang locale, config, at mga naka-cache na salin.
hydrate(input)Pagsamahin ang mga salin at config sa store. Kapaki-pakinabang para sa SSR o custom na bootstrapping.
dehydrate()I-snapshot ang store sa isang hydration payload na madaling i-merge.
loadConfig()Kunin ang mga tinanggap na locale at fallback config nang isang beses, tapos i-cache ang resulta.
itakda angLocale(locale)Simulan ang paglipat ng locale sa loob ng tindahan.
getTranslationSync(input)Sabayang pagbasa na nagbabalik ng alinman sa isang handa nang halaga o isang nakabinbing pagbasa na may kapalit na halaga.
getTranslation(input)Asynchronous na pagsasalin na read na nagre-resolve sa panghuling naisaling string.
naglo-load ba ang input (?)Nagbabalik ng true kapag may nakabinbin pang gawain sa pag-block ng pagsasalin, sa buong sistema o para sa isang context.
maghintayNgIdle(input?)Naresolba kapag humupa na ang nakahahadlang na gawain ng pagsasalin. Ipadala ang timeoutMs para ihinto ang paghihintay pagkatapos ng deadline habang nagpapatuloy ang paglo-load sa background.
getIdleState(input?)Ibinabalik ang state ng timed wait na pagmamay-ari ng store na ginagamit ng mga renderer: {timedOut, promise}.
i-mount(entry) / i-unmount(entry)Opsyonal na pagsubaybay sa mount para sa mga integration na nagpapagana ng mount-aware na garbage collection.

Kung ginagamit mo ang @18ways/core nang direkta, karaniwan ay nananatili ka sa antas ng engine.t(...). Abutin ang store kapag nagbuo ka ng sarili mong rendering runtime o hydration layer.

mga opsyon ng t()

OpsyonUriMga Tala
lokalidadstringI-override ang target na locale para sa tawag na ito.
baseLocalestringI-override ang base locale para sa tawag na ito.
kontekstostring | objectI-override ang context para sa tawag na ito.
varsRecord<string, unknown>Iba’t ibang input para sa waysParser.

Utility exports

Nag-e-export din ang core package ng mga helper na mas mababang antas gaya ng:

  • fetchAcceptedLocales
  • fetchConfig
  • mga utility sa lokasyon

Gamitin mo ang mga iyan kapag kailangan mo ang mga ito, pero ang engine ang dapat na default na panimulang punto.

Sanggunian sa Vanilla JS