Tham chiếu JS thuần
create18waysEngine(options)
Nhập từ @18ways/core/engine.
import { create18waysEngine } from '@18ways/core/engine';Các tùy chọn chung:
| Tùy chọn | Kiểu | Ghi chú |
|---|---|---|
apiKey | chuỗi | Bắt buộc. |
baseLocale | chuỗi | Ngôn ngữ nguồn. |
ngôn ngữ | chuỗi | Ngôn ngữ mục tiêu hiện tại. |
bối cảnh | chuỗi | đối tượng | Khóa ngữ cảnh mặc định. |
initialTranslations | Translations | Bộ nhớ đệm khởi động tùy chọn. |
apiUrl | chuỗi | Ghi đè base API tùy chọn. |
fetcher | kiểu của fetch | Triển khai fetch tùy chỉnh. |
cacheTtlSeconds | số | TTL của bộ nhớ đệm yêu cầu. |
origin | chuỗi | Nguồn gốc được chuyển tiếp trong các yêu cầu phía máy chủ. |
Phương thức động cơ
t(text, options?)
Dịch một chuỗi và trả về giá trị đã được phân giải.
setLocale(locale)
Thay đổi ngôn ngữ mục tiêu.
getLocale()
Đọc ngôn ngữ mục tiêu hiện tại.
getStore()
Truy cập kho lưu trữ bản dịch cơ bản.
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 | Ghi chú |
|---|---|
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()
| Tùy chọn | Kiểu | Ghi chú |
|---|---|---|
ngôn ngữ | chuỗi | Ghi đè ngôn ngữ/khu vực đích cho lần gọi này. |
baseLocale | chuỗi | Ghi đè ngôn ngữ cơ sở cho lần gọi này. |
bối cảnh | chuỗi | đối tượng | Ghi đè ngữ cảnh cho lệnh gọi này. |
biến | Bản ghi<string, unknown> | Đầu vào biến cho waysParser. |
Utility exports
Gói lõi cũng xuất khẩu các hàm trợ giúp cấp thấp hơn như sau:
fetchAcceptedLocalesfetchConfig- tiện ích ngôn ngữ
Hãy dùng những cái đó khi bạn cần, nhưng công cụ tìm kiếm phải là điểm xuất phát mặc định.