Intlayer कॉन्फ़िगरेशन दस्तावेज़

अवलोकन

Intlayer कॉन्फ़िगरेशन फ़ाइलें प्लगइन के विभिन्न पहलुओं जैसे अंतर्राष्ट्रीयकरण, मिडलवेयर, और सामग्री प्रबंधन को अनुकूलित करने की अनुमति देती हैं। यह दस्तावेज़ कॉन्फ़िगरेशन में प्रत्येक प्रॉपर्टी का विस्तृत विवरण प्रदान करता है।

कॉन्फ़िगरेशन फ़ाइल समर्थन

Intlayer JSON, JS, MJS, और TS कॉन्फ़िगरेशन फ़ाइल प्रारूपों को स्वीकार करता है:

• intlayer.config.ts
• intlayer.config.js
• intlayer.config.json
• intlayer.config.cjs
• intlayer.config.mjs
• .intlayerrc

उदाहरण कॉन्फ़िगरेशन फ़ाइल

import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [Locales.ENGLISH],  },  content: {    contentDir: ["src", "../ui-library"],  },  middleware: {    noPrefix: false,  },  editor: {    applicationURL: "https://example.com",  },  ai: {    apiKey: process.env.OPENAI_API_KEY,    applicationContext: "This is a test application",  },  build: {    importMode: "dynamic",  },};export default config;

कॉन्फ़िगरेशन संदर्भ

निम्नलिखित अनुभाग Intlayer के लिए उपलब्ध विभिन्न कॉन्फ़िगरेशन सेटिंग्स का वर्णन करते हैं।

अंतर्राष्ट्रीयकरण कॉन्फ़िगरेशन

अंतर्राष्ट्रीयकरण से संबंधित सेटिंग्स को परिभाषित करता है, जिसमें उपलब्ध लोकल और एप्लिकेशन के लिए डिफ़ॉल्ट लोकल शामिल हैं।

प्रॉपर्टीज़

• locales:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['en']
  • विवरण: एप्लिकेशन में समर्थित लोकल की सूची।
  • उदाहरण: ['en', 'fr', 'es']
• requiredLocales:
  • प्रकार: string[]
  • डिफ़ॉल्ट: []
  • विवरण: एप्लिकेशन में आवश्यक लोकल की सूची।
  • उदाहरण: []
  • नोट: यदि खाली है, तो सभी लोकल strict मोड में आवश्यक हैं।
  • नोट: सुनिश्चित करें कि आवश्यक लोकल भी locales फ़ील्ड में परिभाषित हैं।

• strictMode:

  • प्रकार: string
  • डिफ़ॉल्ट: inclusive
  • विवरण: टाइपस्क्रिप्ट का उपयोग करके अंतर्राष्ट्रीयकृत सामग्री के मजबूत कार्यान्वयन सुनिश्चित करता है।
  • नोट: यदि इसे "strict" पर सेट किया गया है, तो अनुवाद t फ़ंक्शन को प्रत्येक घोषित लोकल को परिभाषित करने की आवश्यकता होगी। यदि कोई लोकल गायब है, या यदि कोई लोकल आपके कॉन्फ़िगरेशन में घोषित नहीं है, तो यह एक त्रुटि फेंकेगा।
  • नोट: यदि इसे "inclusive" पर सेट किया गया है, तो अनुवाद t फ़ंक्शन को प्रत्येक घोषित लोकल को परिभाषित करने की आवश्यकता होगी। यदि कोई लोकल गायब है, तो यह एक चेतावनी देगा। लेकिन यदि कोई लोकल आपके कॉन्फ़िगरेशन में घोषित नहीं है, लेकिन मौजूद है, तो इसे स्वीकार करेगा।
  • नोट: यदि इसे "loose" पर सेट किया गया है, तो अनुवाद t फ़ंक्शन किसी भी मौजूदा लोकल को स्वीकार करेगा।

• defaultLocale:

  • प्रकार: string
  • डिफ़ॉल्ट: 'en'
  • विवरण: डिफ़ॉल्ट लोकल जो अनुरोधित लोकल न मिलने पर फॉलबैक के रूप में उपयोग किया जाता है।
  • उदाहरण: 'en'
  • नोट: यह URL, कुकी, या हेडर में निर्दिष्ट न होने पर लोकल निर्धारित करने के लिए उपयोग किया जाता है।

संपादक कॉन्फ़िगरेशन

एकीकृत संपादक से संबंधित सेटिंग्स को परिभाषित करता है, जिसमें सर्वर पोर्ट और सक्रिय स्थिति शामिल है।

प्रॉपर्टीज़

• applicationURL:

  • प्रकार: string
  • डिफ़ॉल्ट: http://localhost:3000
  • विवरण: एप्लिकेशन का URL। सुरक्षा कारणों से संपादक की उत्पत्ति को प्रतिबंधित करने के लिए उपयोग किया जाता है।
  • उदाहरण:
    • 'http://localhost:3000'
    • 'https://example.com'
    • process.env.INTLAYER_EDITOR_URL
  • नोट: एप्लिकेशन का URL। सुरक्षा कारणों से संपादक की उत्पत्ति को प्रतिबंधित करने के लिए उपयोग किया जाता है। यदि '*' पर सेट है, तो संपादक किसी भी उत्पत्ति से सुलभ है।

• port:

  • प्रकार: number
  • डिफ़ॉल्ट: 8000
  • विवरण: विज़ुअल संपादक सर्वर द्वारा उपयोग किया जाने वाला पोर्ट।

• editorURL:

  • प्रकार: string
  • डिफ़ॉल्ट: 'http://localhost:8000'
  • विवरण: संपादक सर्वर का URL। सुरक्षा कारणों से संपादक की उत्पत्ति को प्रतिबंधित करने के लिए उपयोग किया जाता है।
    • 'http://localhost:3000'
    • 'https://example.com'
    • process.env.INTLAYER_EDITOR_URL
  • नोट: एप्लिकेशन से पहुंचने के लिए संपादक सर्वर का URL। एप्लिकेशन के साथ इंटरैक्ट करने के लिए उत्पत्तियों को प्रतिबंधित करने के लिए उपयोग किया जाता है। यदि '*' पर सेट है, तो संपादक किसी भी उत्पत्ति से सुलभ है। यदि पोर्ट बदला गया है, या यदि संपादक किसी अन्य डोमेन पर होस्ट किया गया है, तो इसे सेट किया जाना चाहिए।

• cmsURL:

  • प्रकार: string
  • डिफ़ॉल्ट: 'https://intlayer.org'
  • विवरण: Intlayer CMS का URL।
  • उदाहरण: 'https://intlayer.org'
  • नोट: Intlayer CMS का URL।

• backendURL:

  • प्रकार: string
  • डिफ़ॉल्ट: https://back.intlayer.org
  • विवरण: बैकएंड सर्वर का URL।
  • उदाहरण: http://localhost:4000

• enabled:

  • प्रकार: boolean
  • डिफ़ॉल्ट: true
  • विवरण: यह दर्शाता है कि एप्लिकेशन विज़ुअल संपादक के साथ इंटरैक्ट करता है या नहीं।
  • उदाहरण: process.env.NODE_ENV !== 'production'
  • नोट: यदि true है, तो संपादक एप्लिकेशन के साथ इंटरैक्ट कर सकेगा। यदि false है, तो संपादक एप्लिकेशन के साथ इंटरैक्ट नहीं कर सकेगा। किसी भी स्थिति में, संपादक केवल विज़ुअल संपादक द्वारा सक्षम किया जा सकता है। विशिष्ट वातावरणों के लिए संपादक को अक्षम करना सुरक्षा को लागू करने का एक तरीका है।

• clientId:

  • प्रकार: string | undefined
  • डिफ़ॉल्ट: undefined
  • विवरण: clientId और clientSecret Intlayer पैकेजों को oAuth2 प्रमाणीकरण का उपयोग करके बैकएंड के साथ प्रमाणित करने की अनुमति देते हैं। एक एक्सेस टोकन का उपयोग प्रोजेक्ट से संबंधित उपयोगकर्ता को प्रमाणित करने के लिए किया जाता है। एक्सेस टोकन प्राप्त करने के लिए, https://intlayer.org/dashboard/project पर जाएं और एक खाता बनाएं।
  • उदाहरण: true
  • नोट: महत्वपूर्ण: clientId और clientSecret को गुप्त रखा जाना चाहिए और सार्वजनिक रूप से साझा नहीं किया जाना चाहिए। कृपया सुनिश्चित करें कि उन्हें एक सुरक्षित स्थान पर रखें, जैसे पर्यावरण चर।

• clientSecret:

  • प्रकार: string | undefined
  • डिफ़ॉल्ट: undefined
  • विवरण: clientId और clientSecret Intlayer पैकेजों को oAuth2 प्रमाणीकरण का उपयोग करके बैकएंड के साथ प्रमाणित करने की अनुमति देते हैं। एक एक्सेस टोकन का उपयोग प्रोजेक्ट से संबंधित उपयोगकर्ता को प्रमाणित करने के लिए किया जाता है। एक्सेस टोकन प्राप्त करने के लिए, https://intlayer.org/dashboard/project पर जाएं और एक खाता बनाएं।
  • उदाहरण: true
  • नोट: महत्वपूर्ण: clientId और clientSecret को गुप्त रखा जाना चाहिए और सार्वजनिक रूप से साझा नहीं किया जाना चाहिए। कृपया सुनिश्चित करें कि उन्हें एक सुरक्षित स्थान पर रखें, जैसे पर्यावरण चर।

• hotReload:

  • प्रकार: boolean
  • डिफ़ॉल्ट: false
  • विवरण: यह दर्शाता है कि एप्लिकेशन को लोकल कॉन्फ़िगरेशन में परिवर्तन का पता लगने पर हॉट रीलोड करना चाहिए।
  • उदाहरण: true
  • नोट: उदाहरण के लिए, जब एक नया शब्दकोश जोड़ा या अपडेट किया जाता है, तो एप्लिकेशन पृष्ठ में प्रदर्शित सामग्री को अपडेट करेगा।
  • नोट: क्योंकि हॉट रीलोडिंग को सर्वर के साथ एक सतत कनेक्शन की आवश्यकता होती है, यह केवल enterprise योजना के ग्राहकों के लिए उपलब्ध है।

• dictionaryPriorityStrategy:

  • प्रकार: string
  • डिफ़ॉल्ट: 'local_first'
  • विवरण: स्थानीय और दूरस्थ शब्दकोश दोनों के मौजूद होने की स्थिति में प्राथमिकता देने की रणनीति। यदि 'distant_first' पर सेट है, तो एप्लिकेशन दूरस्थ शब्दकोशों को स्थानीय शब्दकोशों पर प्राथमिकता देगा। यदि 'local_first' पर सेट है, तो एप्लिकेशन स्थानीय शब्दकोशों को दूरस्थ शब्दकोशों पर प्राथमिकता देगा।
  • उदाहरण: 'distant_first'

मिडलवेयर कॉन्फ़िगरेशन

मिडलवेयर व्यवहार को नियंत्रित करने वाली सेटिंग्स, जिसमें एप्लिकेशन कुकीज़, हेडर, और लोकल प्रबंधन के लिए URL प्रीफिक्स को कैसे संभालता है, शामिल हैं।

प्रॉपर्टीज़

• headerName:

  • प्रकार: string
  • डिफ़ॉल्ट: 'x-intlayer-locale'
  • विवरण: लोकल निर्धारित करने के लिए उपयोग किए जाने वाले HTTP हेडर का नाम।
  • उदाहरण: 'x-custom-locale'
  • नोट: यह API-आधारित लोकल निर्धारण के लिए उपयोगी है।

• cookieName:

  • प्रकार: string
  • डिफ़ॉल्ट: 'intlayer-locale'
  • विवरण: कुकी का नाम जो लोकेल को स्टोर करने के लिए उपयोग किया जाता है।
  • उदाहरण: 'custom-locale'
  • नोट: सत्रों के बीच लोकेल को बनाए रखने के लिए उपयोग किया जाता है।

• prefixDefault:

  • प्रकार: boolean
  • डिफ़ॉल्ट: false
  • विवरण: क्या URL में डिफ़ॉल्ट लोकेल शामिल करना है।
  • उदाहरण: true
  • नोट:
    • यदि true और defaultLocale = 'en': path = /en/dashboard या /fr/dashboard
    • यदि false और defaultLocale = 'en': path = /dashboard या /fr/dashboard

• basePath:

  • प्रकार: string
  • डिफ़ॉल्ट: ''
  • विवरण: एप्लिकेशन URL के लिए बेस पथ।
  • उदाहरण: '/my-app'
  • नोट:
    • यदि एप्लिकेशन https://example.com/my-app पर होस्ट की गई है
    • बेस पथ '/my-app' है
    • URL https://example.com/my-app/en होगा
    • यदि बेस पथ सेट नहीं है, तो URL https://example.com/en होगा

• serverSetCookie:

  • प्रकार: string
  • डिफ़ॉल्ट: 'always'
  • विवरण: सर्वर पर लोकेल कुकी सेट करने का नियम।
  • विकल्प: 'always', 'never'
  • उदाहरण: 'never'
  • नोट: नियंत्रित करता है कि लोकेल कुकी हर अनुरोध पर सेट की जाए या कभी नहीं।

• noPrefix:

  • प्रकार: boolean
  • डिफ़ॉल्ट: false
  • विवरण: क्या URL से लोकेल प्रीफ़िक्स हटाना है।
  • उदाहरण: true
  • नोट:
    • यदि true: URL में कोई प्रीफ़िक्स नहीं
    • यदि false: URL में प्रीफ़िक्स है
    • basePath = '/my-app' के साथ उदाहरण:
      • यदि noPrefix = false: URL https://example.com/my-app/en होगा
      • यदि noPrefix = true: URL https://example.com होगा

• detectLocaleOnPrefetchNoPrefix:

  • प्रकार: boolean
  • डिफ़ॉल्ट: false
  • विवरण: नियंत्रित करता है कि Next.js प्रीफ़ेच अनुरोधों के दौरान लोकेल पता लगाना होता है या नहीं।
  • उदाहरण: true
  • नोट: यह सेटिंग प्रभावित करती है कि Next.js लोकेल प्रीफ़ेचिंग को कैसे संभालता है:
    • उदाहरण परिदृश्य:
      • उपयोगकर्ता का ब्राउज़र भाषा 'fr' है
      • वर्तमान पृष्ठ /fr/about है
      • लिंक प्रीफ़ेच करता है /about
    • detectLocaleOnPrefetchNoPrefix: true के साथ:
      • प्रीफ़ेच ब्राउज़र से 'fr' लोकेल का पता लगाता है
      • प्रीफ़ेच को /fr/about पर रीडायरेक्ट करता है
    • detectLocaleOnPrefetchNoPrefix: false (डिफ़ॉल्ट) के साथ:
      • प्रीफ़ेच डिफ़ॉल्ट लोकेल का उपयोग करता है
      • प्रीफ़ेच को /en/about पर रीडायरेक्ट करता है (यह मानते हुए कि 'en' डिफ़ॉल्ट है)
    • कब true का उपयोग करें:
      • आपका ऐप गैर-स्थानीयकृत आंतरिक लिंक का उपयोग करता है (जैसे <a href="/about">)
      • आप सामान्य और प्रीफ़ेच अनुरोधों के बीच सुसंगत लोकेल पता लगाने का व्यवहार चाहते हैं
    • कब false (डिफ़ॉल्ट) का उपयोग करें:
      • आपका ऐप लोकेल-प्रीफ़िक्स वाले लिंक का उपयोग करता है (जैसे <a href="/fr/about">)
      • आप प्रीफ़ेचिंग प्रदर्शन को अनुकूलित करना चाहते हैं
      • आप संभावित रीडायरेक्ट लूप से बचना चाहते हैं

सामग्री कॉन्फ़िगरेशन

एप्लिकेशन के भीतर सामग्री प्रबंधन से संबंधित सेटिंग्स, जैसे कि निर्देशिका नाम, फ़ाइल एक्सटेंशन, और व्युत्पन्न कॉन्फ़िगरेशन।

गुण

• watch:

  • प्रकार: boolean
  • डिफ़ॉल्ट: process.env.NODE_ENV === 'development'
  • विवरण: यह इंगित करता है कि Intlayer को ऐप में सामग्री घोषणा फ़ाइलों में परिवर्तन देखने चाहिए या नहीं, ताकि संबंधित शब्दकोशों को पुनर्निर्मित किया जा सके।

• fileExtensions:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['.content.ts', '.content.js', '.content.cjs', '.content.mjs', '.content.json', '.content.tsx', '.content.jsx']
  • विवरण: शब्दकोश बनाने के समय देखने के लिए फ़ाइल एक्सटेंशन।
  • उदाहरण: ['.data.ts', '.data.js', '.data.json']

• नोट: फ़ाइल एक्सटेंशन को अनुकूलित करने से संघर्ष से बचने में मदद मिल सकती है।

• baseDir:

  • प्रकार: string
  • डिफ़ॉल्ट: process.cwd()
  • विवरण: प्रोजेक्ट के लिए बेस निर्देशिका।
  • उदाहरण: '/path/to/project'
  • नोट: यह सभी Intlayer-संबंधित निर्देशिकाओं को हल करने के लिए उपयोग किया जाता है।

• dictionaryOutput:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['intlayer']
  • विवरण: उपयोग के लिए शब्दकोश आउटपुट का प्रकार, जैसे 'intlayer' या 'i18next'।

• contentDir:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['src']
  • उदाहरण: ['src', '../../ui-library', require.resolve("@my-package/content")]
  • विवरण: वह निर्देशिका पथ जहां सामग्री संग्रहीत होती है।

• dictionariesDir:

  • प्रकार: string
  • डिफ़ॉल्ट: '.intlayer/dictionaries'
  • विवरण: मध्यवर्ती या आउटपुट परिणाम संग्रहीत करने के लिए निर्देशिका पथ।

• moduleAugmentationDir:

  • प्रकार: string
  • डिफ़ॉल्ट: '.intlayer/types'
  • विवरण: मॉड्यूल वृद्धि के लिए निर्देशिका, बेहतर IDE सुझाव और प्रकार जांच की अनुमति देती है।
  • उदाहरण: 'intlayer-types'
  • नोट: इसे tsconfig.json में शामिल करना सुनिश्चित करें।

• unmergedDictionariesDir:

  • प्रकार: string
  • डिफ़ॉल्ट: '.intlayer/unmerged_dictionary'
  • विवरण: असंयुक्त शब्दकोशों को संग्रहीत करने के लिए निर्देशिका।
  • उदाहरण: 'translations'

• dictionariesDir:

  • प्रकार: string
  • डिफ़ॉल्ट: '.intlayer/dictionary'
  • विवरण: स्थानीयकरण शब्दकोशों को संग्रहीत करने के लिए निर्देशिका।
  • उदाहरण: 'translations'

• i18nextResourcesDir:

  • प्रकार: string
  • डिफ़ॉल्ट: 'i18next_dictionary'
  • विवरण: i18n शब्दकोशों को संग्रहीत करने के लिए निर्देशिका।
  • उदाहरण: 'translations'
  • नोट: सुनिश्चित करें कि यह निर्देशिका i18next आउटपुट प्रकार के लिए कॉन्फ़िगर की गई है।

• typesDir:

  • प्रकार: string
  • डिफ़ॉल्ट: 'types'
  • विवरण: शब्दकोश प्रकार संग्रहीत करने के लिए निर्देशिका।
  • उदाहरण: 'intlayer-types'

• mainDir:

  • प्रकार: string
  • डिफ़ॉल्ट: 'main'
  • विवरण: वह निर्देशिका जहां मुख्य एप्लिकेशन फ़ाइलें संग्रहीत की जाती हैं।
  • उदाहरण: 'intlayer-main'

• excludedPath:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['node_modules']
  • विवरण: सामग्री खोज से बाहर की गई निर्देशिकाएँ।
  • नोट: यह सेटिंग अभी उपयोग में नहीं है, लेकिन भविष्य के कार्यान्वयन के लिए योजना बनाई गई है।

लॉगर कॉन्फ़िगरेशन

लॉगर को नियंत्रित करने वाली सेटिंग्स, जिसमें उपयोग करने के लिए प्रीफ़िक्स शामिल है।

गुण

• mode:

  • प्रकार: string
  • डिफ़ॉल्ट: default
  • विवरण: लॉगर का मोड इंगित करता है।
  • विकल्प: default, verbose, disabled
  • उदाहरण: default
  • नोट: लॉगर का मोड। वर्बोज़ मोड अधिक जानकारी लॉग करेगा, लेकिन इसे डिबगिंग उद्देश्यों के लिए उपयोग किया जा सकता है। डिसेबल्ड मोड लॉगर को अक्षम कर देगा।

• prefix:

  • प्रकार: string
  • डिफ़ॉल्ट: '[intlayer] '
  • विवरण: लॉगर का प्रीफ़िक्स।
  • उदाहरण: '[my custom prefix] '
  • नोट: लॉगर का प्रीफ़िक्स।

एआई कॉन्फ़िगरेशन

Intlayer की एआई सुविधाओं को नियंत्रित करने वाली सेटिंग्स, जिसमें प्रदाता, मॉडल, और एपीआई कुंजी शामिल हैं। यह कॉन्फ़िगरेशन वैकल्पिक है यदि आप Intlayer डैशबोर्ड पर एक एक्सेस कुंजी का उपयोग करके पंजीकृत हैं। Intlayer आपकी आवश्यकताओं के लिए सबसे कुशल और लागत-प्रभावी एआई समाधान को स्वचालित रूप से प्रबंधित करेगा। डिफ़ॉल्ट विकल्पों का उपयोग करना बेहतर दीर्घकालिक रखरखाव सुनिश्चित करता है क्योंकि Intlayer लगातार सबसे प्रासंगिक मॉडलों का उपयोग करने के लिए अपडेट होता रहता है।

यदि आप अपनी एपीआई कुंजी या विशिष्ट मॉडल का उपयोग करना पसंद करते हैं, तो आप अपनी कस्टम एआई कॉन्फ़िगरेशन परिभाषित कर सकते हैं। यह एआई कॉन्फ़िगरेशन आपके Intlayer वातावरण में वैश्विक रूप से उपयोग किया जाएगा। CLI कमांड इन सेटिंग्स का उपयोग कमांड (जैसे fill) के लिए डिफ़ॉल्ट के रूप में करेंगे, साथ ही SDK, विज़ुअल एडिटर, और CMS। आप विशिष्ट उपयोग मामलों के लिए कमांड पैरामीटर का उपयोग करके इन डिफ़ॉल्ट मानों को ओवरराइड कर सकते हैं। Intlayer बेहतर लचीलापन और विकल्प के लिए कई एआई प्रदाताओं का समर्थन करता है। वर्तमान में समर्थित प्रदाता हैं:

• OpenAI (डिफ़ॉल्ट)
• Anthropic Claude
• Mistral AI
• DeepSeek
• Google Gemini
• Meta Llama

गुण

• provider:

  • प्रकार: string
  • डिफ़ॉल्ट: 'openai'
  • विवरण: Intlayer की एआई सुविधाओं के लिए उपयोग करने वाला प्रदाता।
  • विकल्प: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini'
  • उदाहरण: 'anthropic'
  • नोट: विभिन्न प्रदाताओं को विभिन्न एपीआई कुंजियों की आवश्यकता हो सकती है और उनकी अलग-अलग मूल्य निर्धारण मॉडल हो सकते हैं।

• model:

  • प्रकार: string
  • डिफ़ॉल्ट: कोई नहीं
  • विवरण: Intlayer की एआई सुविधाओं के लिए उपयोग करने वाला मॉडल।
  • उदाहरण: 'gpt-4o-2024-11-20'
  • नोट: उपयोग करने के लिए विशिष्ट मॉडल प्रदाता के अनुसार भिन्न होता है।

• temperature:

  • प्रकार: number
  • डिफ़ॉल्ट: कोई नहीं
  • विवरण: तापमान एआई की प्रतिक्रियाओं की अनियमितता को नियंत्रित करता है।
  • उदाहरण: 0.1
  • नोट: उच्च तापमान एआई को अधिक रचनात्मक और कम अनुमानित बनाएगा।

• apiKey:

  • प्रकार: string
  • डिफ़ॉल्ट: कोई नहीं
  • विवरण: चयनित प्रदाता के लिए आपकी एपीआई कुंजी।
  • उदाहरण: process.env.OPENAI_API_KEY
  • नोट: महत्वपूर्ण: एपीआई कुंजियों को गुप्त रखा जाना चाहिए और सार्वजनिक रूप से साझा नहीं किया जाना चाहिए। कृपया उन्हें एक सुरक्षित स्थान पर रखें, जैसे पर्यावरण चर।

• applicationContext:

  • प्रकार: string
  • डिफ़ॉल्ट: कोई नहीं
  • विवरण: एआई मॉडल को आपके एप्लिकेशन के बारे में अतिरिक्त संदर्भ प्रदान करता है, जिससे यह अधिक सटीक और संदर्भ-उपयुक्त अनुवाद उत्पन्न करने में मदद करता है। इसमें आपके एप्लिकेशन के डोमेन, लक्षित दर्शकों, स्वर, या विशिष्ट शब्दावली के बारे में जानकारी शामिल हो सकती है।

बिल्ड कॉन्फ़िगरेशन

सेटिंग्स जो नियंत्रित करती हैं कि Intlayer आपके एप्लिकेशन के अंतर्राष्ट्रीयकरण को कैसे अनुकूलित और बिल्ड करता है।

बिल्ड विकल्प @intlayer/babel और @intlayer/swc प्लगइन्स पर लागू होते हैं।

विकास मोड में, Intlayer विकास अनुभव को सरल बनाने के लिए शब्दकोशों के लिए स्थैतिक आयात का उपयोग करता है।

अनुकूलन के दौरान, Intlayer चंकिंग को अनुकूलित करने के लिए शब्दकोशों के कॉल को बदल देगा, ताकि अंतिम बंडल केवल वास्तव में उपयोग किए गए शब्दकोशों को आयात करे।

गुण

• optimize:

  • प्रकार: boolean
  • डिफ़ॉल्ट: process.env.NODE_ENV === 'production'
  • विवरण: नियंत्रित करता है कि बिल्ड को अनुकूलित किया जाना चाहिए या नहीं।
  • उदाहरण: true
  • नोट: जब सक्षम किया जाता है, तो Intlayer चंकिंग को अनुकूलित करने के लिए शब्दकोशों के सभी कॉल को बदल देगा। इस तरह अंतिम बंडल केवल उपयोग किए गए शब्दकोशों को आयात करेगा। सभी आयात स्थैतिक आयात के रूप में रहेंगे ताकि शब्दकोशों को लोड करते समय अतुल्यकालिक प्रसंस्करण से बचा जा सके।
  • नोट: Intlayer importMode विकल्प द्वारा परिभाषित मोड के साथ सभी useIntlayer कॉल को बदल देगा और getIntlayer को getDictionary से बदल देगा।
  • नोट: यह विकल्प @intlayer/babel और @intlayer/swc प्लगइन्स पर निर्भर करता है।
  • नोट: सुनिश्चित करें कि सभी कुंजियाँ useIntlayer कॉल में स्थैतिक रूप से घोषित की गई हैं। उदाहरण: useIntlayer('navbar')।

• importMode:

  • प्रकार: 'static' | 'dynamic' | 'async'
  • डिफ़ॉल्ट: 'static'
  • विवरण: नियंत्रित करता है कि शब्दकोश कैसे आयात किए जाते हैं।
  • उदाहरण: 'dynamic'
  • नोट: उपलब्ध मोड:
    • "static": शब्दकोश स्थैतिक रूप से आयात किए जाते हैं। useIntlayer को useDictionary से बदलता है।
    • "dynamic": शब्दकोश Suspense का उपयोग करके डायनामिक रूप से आयात किए जाते हैं। useIntlayer को useDictionaryDynamic से बदलता है।
    • "async": शब्दकोश अतुल्यकालिक रूप से डायनामिक रूप से आयात किए जाते हैं। useIntlayer को await useDictionaryAsync से बदलता है।
  • नोट: डायनामिक आयात Suspense पर निर्भर करते हैं और रेंडरिंग प्रदर्शन को थोड़ा प्रभावित कर सकते हैं।
  • नोट: यदि अक्षम है तो सभी भाषाएँ एक साथ लोड की जाएंगी, भले ही वे उपयोग में न हों।
  • नोट: यह विकल्प @intlayer/babel और @intlayer/swc प्लगइन्स पर निर्भर करता है।
  • नोट: सुनिश्चित करें कि सभी कुंजियाँ useIntlayer कॉल में स्थैतिक रूप से घोषित की गई हैं। उदाहरण: useIntlayer('navbar')।
  • नोट: यह विकल्प अनदेखा कर दिया जाएगा यदि optimize अक्षम है।
  • नोट: अधिकांश मामलों में, React एप्लिकेशन के लिए "dynamic" का उपयोग किया जाएगा, Vue.js एप्लिकेशन के लिए "async" का उपयोग किया जाएगा।
  • नोट: यह विकल्प getIntlayer, getDictionary, useDictionary, useDictionaryAsync और useDictionaryDynamic फ़ंक्शन को प्रभावित नहीं करेगा।

• traversePattern:

  • प्रकार: string[]
  • डिफ़ॉल्ट: ['**/*.{js,ts,mjs,cjs,jsx,tsx,mjx,cjx}', '!**/node_modules/**']
  • विवरण: पैटर्न जो परिभाषित करते हैं कि अनुकूलन के दौरान किन फ़ाइलों को पार किया जाना चाहिए।
    • उदाहरण: ['src/**/*.{ts,tsx}', '../ui-library/**/*.{ts,tsx}', '!**/node_modules/**']
  • नोट: प्रासंगिक कोड फ़ाइलों तक अनुकूलन को सीमित करने और बिल्ड प्रदर्शन में सुधार करने के लिए इसका उपयोग करें।
  • नोट: यह विकल्प अनदेखा कर दिया जाएगा यदि optimize अक्षम है।
  • नोट: glob पैटर्न का उपयोग करें।

Doc History

• 5.5.11 - 2025-06-29: docs कमांड जोड़ा गया