Vanilla JS reference
create18waysEngine(options)
Nhập từ @18ways/core/engine.
import { create18waysEngine } from '@18ways/core/engine';Common options:
| Option | Type | Notes |
|---|---|---|
apiKey | string | Required. |
baseLocale | string | Source locale. |
locale | string | Current target locale. |
context | string | object | Default context key. |
initialTranslations | Translations | Optional starting cache. |
apiUrl | string | Optional API base override. |
fetcher | typeof fetch | Custom fetch implementation. |
cacheTtlSeconds | number | Request cache TTL. |
origin | string | Origin forwarded on server-side requests. |
Engine methods
t(text, options?)
Translate a string and return the resolved value.
setLocale(locale)
Change the target locale.
getLocale()
Read the current target locale.
getStore()
Access the underlying translation store.
TranslationStore
engine.getStore() cung cấp máy trạng thái runtime cấp thấp hơn. Store sở hữu trạng thái locale,
cấu hình, bản dịch đã hydrate, các chuỗi nguồn đã ghi nhớ, và trạng thái tải đang chặn.
Các phương thức thường dùng:
| Phương thức | Notes |
|---|---|
getState() | Đọc locale được chọn hiện tại, locale đã ổn định, cấu hình và các bản dịch đã lưu đệm. |
hydrate(input) | Gộp bản dịch và cấu hình vào store. Hữu ích cho SSR hoặc khởi động tuỳ biến. |
dehydrate() | Chụp snapshot của store thành một payload hydration thân thiện với việc gộp. |
loadConfig() | Tìm nạp locale đã chấp nhận và cấu hình fallback một lần, rồi lưu kết quả vào bộ nhớ đệm. |
setLocale(locale) | Khởi động một lượt chuyển locale bên trong store. |
getTranslationSync(input) | Lượt đọc đồng bộ trả về либо giá trị sẵn sàng, либо lượt đọc đang chờ với một giá trị fallback. |
getTranslation(input) | Lượt đọc bản dịch bất đồng bộ, phân giải thành chuỗi đã dịch cuối cùng. |
isLoading(input?) | Trả về true khi công việc dịch đang chặn vẫn còn đang chờ, trên toàn cục hoặc cho một ngữ cảnh. |
waitForIdle(input?) | Phân giải khi công việc dịch đang chặn ổn định. Truyền timeoutMs để ngừng chờ sau khi hết hạn trong lúc việc tải vẫn tiếp tục ở nền. |
getIdleState(input?) | Trả về trạng thái chờ có tính thời gian do store sở hữu mà renderer dùng: {timedOut, promise}. |
mount(entry) / unmount(entry) | Theo dõi mount tùy chọn cho các tích hợp bật thu gom rác có nhận biết mount. |
Nếu bạn đang dùng trực tiếp @18ways/core, thường bạn sẽ dừng ở mức engine.t(...). Hãy tìm đến
store khi bạn đang xây dựng runtime render hoặc lớp hydration của riêng mình.
Tùy chọn t()
| Option | Type | Notes |
|---|---|---|
locale | string | Override the target locale for this call. |
baseLocale | string | Override the base locale for this call. |
context | string | object | Override the context for this call. |
vars | Record<string, unknown> | Đầu vào biến cho waysParser. |
Utility exports
The core package also exports lower-level helpers such as:
fetchAcceptedLocalesfetchConfig- locale utilities
Use those when you need them, but the engine should be the default starting point.