वैनिला JS संदर्भ
create18waysEngine(options)
इम्पोर्ट करें @18ways/core/engine से.
import { create18waysEngine } from '@18ways/core/engine';सामान्य विकल्प:
| विकल्प | टाइप | नोट्स |
|---|---|---|
apiKey | स्ट्रिंग | आवश्यक। |
baseLocale | स्ट्रिंग | स्रोत लोकेल। |
लोकेल | स्ट्रिंग | वर्तमान लक्षित लोकेल। |
संदर्भ | स्ट्रिंग | ऑब्जेक्ट | डिफ़ॉल्ट संदर्भ कुंजी। |
प्रारंभिक अनुवाद | अनुवाद | वैकल्पिक प्रारम्भिक कैश. |
apiUrl | स्ट्रिंग | वैकल्पिक API बेस ओवरराइड। |
fetcher | fetch का प्रकार | कस्टम फ़ेच कार्यान्वयन. |
cacheTtlSeconds | संख्या | अनुरोध कैश TTL. |
मूल | स्ट्रिंग | मूल सर्वर-साइड अनुरोधों पर अग्रेषित किया गया। |
इंजन मेथड्स
t(text, options?)
एक स्ट्रिंग का अनुवाद करें और हल किया गया मान लौटाएँ।
setLocale(locale)
लक्ष्य लोकेल बदलें।
getLocale()
वर्तमान लक्षित लोकेल पढ़ें।
getStore()
अंतर्निहित अनुवाद स्टोर तक पहुँचें।
TranslationStore
engine.getStore() निचले-स्तर की runtime state machine को expose करता है। store locale state, config, hydrated translations, याद रखे गए source strings, और blocking loading state का मालिक होता है।
आम methods:
| Method | नोट्स |
|---|---|
getState() | वर्तमान selected locale, settled locale, config, और cached translations पढ़ता है। |
hydrate(input) | translations और config को store में merge करें। SSR या custom bootstrapping के लिए उपयोगी। |
dehydrate() | store को merge-friendly hydration payload में snapshot करें। |
loadConfig() | accepted locales और fallback config को एक बार fetch करें, फिर परिणाम cache करें। |
setLocale(locale) | स्टोर के अंदर एक लोकेल संक्रमण शुरू करें। |
getTranslationSync(input) | एक synchronous read जो या तो ready value लौटाता है या fallback value के साथ एक pending read। |
getTranslation(input) | अंतिम अनुवादित string पर resolve होने वाली async translation read। |
isLoading(input?) | जब ब्लॉकिंग translation work अभी भी लंबित हो, वैश्विक रूप से या किसी एक context के लिए, तो true लौटाता है। |
idle होने तक प्रतीक्षा करें(input?) | जब ब्लॉकिंग translation work स्थिर हो जाए, तब resolve होता है। लोडिंग बैकग्राउंड में जारी रहते हुए, एक deadline के बाद प्रतीक्षा बंद करने के लिए timeoutMs पास करें। |
getIdleState(input?) | renderer द्वारा उपयोग की जाने वाली store-स्वामित्व वाली timed wait state लौटाता है: {timedOut, promise}. |
माउंट(entry) / अनमाउंट(entry) | माउंट-अवेयर कचरा संग्रहण को सक्षम करने वाले इंटीग्रेशनों के लिए वैकल्पिक माउंट ट्रैकिंग. |
अगर आप सीधे @18ways/core का उपयोग कर रहे हैं, तो आप आम तौर पर engine.t(...) स्तर पर ही रहते हैं। जब आप अपना rendering runtime या hydration layer बना रहे हों, तब store की ओर जाएँ।
t() विकल्प
| विकल्प | टाइप | नोट्स |
|---|---|---|
लोकेल | स्ट्रिंग | इस कॉल के लिए लक्षित लोकेल को ओवरराइड करें. |
baseLocale | स्ट्रिंग | इस कॉल के लिए आधार लोकेल को ओवरराइड करें। |
संदर्भ | स्ट्रिंग | ऑब्जेक्ट | इस कॉल के लिए संदर्भ को ओवरराइड करें। |
vars | रिकॉर्ड<string, unknown> | waysParser के लिए परिवर्ती इनपुट. |
Utility exports
कोर पैकेज निम्न जैसे निम्न-स्तरीय सहायक भी निर्यात करता है:
fetchAcceptedLocalesfetchConfig- स्थानीयकरण उपयोगिताएँ
जब ज़रूरत हो, उनका इस्तेमाल करें, लेकिन इंजन डिफ़ॉल्ट शुरुआती बिंदु होना चाहिए।