प्रलेखन: getLocalizedPath फ़ंक्शन intlayer में

विवरण

The getLocalizedPath फ़ंक्शन एक कैनोनिकल पाथ (आंतरिक एप्लिकेशन पाथ) को दिए गए locale और rewrite नियमों के आधार पर उसके लोकलाइज़्ड समतुल्य में resolve करता है। यह विशेष रूप से उन SEO-friendly URLs को जनरेट करने के लिए उपयोगी है जो भाषा के अनुसार बदलते हैं।

यह getLocalizedUrl का सापेक्ष समकक्ष है — एक सापेक्ष इनपुट के लिए दोनों समान मान लौटाते हैं। getLocalizedUrl के विपरीत, यह कभी भी एक निरपेक्ष URL नहीं लौटाता है: domains कॉन्फ़िगरेशन को अनदेखा किया जाता है, इसलिए एक लोकेल जो अपने स्वयं के डोमेन से परोसा जाता है फिर भी एक पथ प्राप्त करता है। एक निरपेक्ष इनपुट स्वीकार किया जाता है, लेकिन इसकी उत्पत्ति को छोड़ दिया जाता है — केवल इसका पथ, क्वेरी स्ट्रिंग और हैश रखे जाते हैं।

मुख्य विशेषताएँ:

• [param] सिंटैक्स का उपयोग करके डायनामिक रूट पैरामीटर का समर्थन करता है।
• आपकी कॉन्फ़िगरेशन में परिभाषित कस्टम rewrite नियमों के अनुसार पाथ को resolve करता है।
• यदि निर्दिष्ट locale के लिए कोई rewrite नियम नहीं मिलता है तो यह स्वचालित रूप से कैनोनिकल पाथ पर fallback संभालता है।

फ़ंक्शन सिग्नेचर

getLocalizedPath(
  canonicalPath: string,         // अनिवार्य
  locale: Locales,               // अनिवार्य
  rewriteRules?: RoutingConfig['rewrite'] // वैकल्पिक
): string

पैरामीटर

आवश्यक पैरामीटर

• canonicalPath: string
  • विवरण: आंतरिक एप्लिकेशन पथ (उदा., /about, /product/[id])।
  • प्रकार: string
  • आवश्यक: हाँ

वैकल्पिक पैरामीटर

• locale?: Locales

  • Description: वह target locale जिसके लिए path को localize किया जाना चाहिए।
  • Type: Locales
  • Default: आपकी project के configuration का default locale।

• options?: object

  • Description: Routing ओवरराइड्स। प्रत्येक entry आपके project के configuration पर default होता है।
  • Type: object

• rewriteRules?: RoutingConfig['rewrite']

  • विवरण: कस्टम rewrite नियमों को परिभाषित करने वाला एक ऑब्जेक्ट। यदि प्रदान नहीं किया गया है, तो यह आपके प्रोजेक्ट कॉन्फ़िगरेशन की routing.rewrite प्रॉपर्टी पर डिफॉल्ट होगा।
  • प्रकार: RoutingConfig['rewrite']
  • डिफ़ॉल्ट: configuration.routing.rewrite

रिटर्न

• प्रकार: string
• विवरण: निर्दिष्ट locale के लिए स्थानीयकृत पथ।

प्रकार आपके कॉन्फ़िगरेशन में घोषित rewrite rules से narrow किया जाता है, इसलिए editor एक bare string के बजाय resolved path दिखाता है:

// कॉन्फ़िगरेशन: मोड 'prefix-no-default', defaultLocale 'en',
//                { '/about': { fr: '/a-propos' }, '/product/[id]': { fr: '/produit/[id]' } }
const about = getLocalizedPath("/about", Locales.FRENCH);
//    ^? '/fr/a-propos'
const product = getLocalizedPath("/product/123", Locales.FRENCH);
//    ^? '/fr/produit/123'
const contact = getLocalizedPath("/contact", Locales.FRENCH);
//    ^? '/fr/contact'  (कोई रीराइट नियम मेल नहीं खाता, केवल प्रीफिक्स लागू किया जाता है)
const home = getLocalizedPath("/", Locales.FRENCH);
//    ^? '/fr'

यही संकीर्णन getLocalizedUrl में बहता है, जो locale को prefix करने से पहले rewrite rules को लागू करता है।

दो मामले string तक विस्तृत रहते हैं, क्योंकि उन्हें compile time पर resolve नहीं किया जा सकता:

• एक path जो string literal नहीं है (उदाहरण के लिए, एक variable से बनाई गई);
• एक path जो multi-segment या optional parameter का उपयोग करते हुए एक rule से मेल खाती है ([...slug], [[...slug]], :param?)।

उदाहरण उपयोग

बुनियादी उपयोग (कॉन्फ़िगरेशन के साथ)

यदि आपने अपने intlayer.config.ts में कस्टम rewrite नियम कॉन्फ़िगर किए हैं:

import { getLocalizedPath, Locales } from "intlayer";

// कॉन्फ़िगरेशन: { '/about': { en: '/about', fr: '/a-propos' } }
getLocalizedPath("/about", Locales.FRENCH);
// आउटपुट: "/a-propos"

getLocalizedPath("/about", Locales.ENGLISH);
// आउटपुट: "/about"

डायनामिक राउट्स के साथ उपयोग

import { getLocalizedPath, Locales } from "intlayer";

// कॉन्फ़िगरेशन: { '/product/[id]': { en: '/product/[id]', fr: '/produit/[id]' } }
getLocalizedPath("/product/123", Locales.FRENCH);
// आउटपुट: "/produit/123"

मैन्युअल रीव्राइट नियम

आप फ़ंक्शन को मैन्युअल रीव्राइट नियम भी पास कर सकते हैं:

import { getLocalizedPath, Locales } from "intlayer";

const manualRules = {
  "/contact": {
    en: "/contact-us",
    fr: "/contactez-nous",
  },
};

getLocalizedPath("/contact", Locales.FRENCH, manualRules);
// Output: "/contactez-nous"

Locale को छोड़ना

जब कोई locale नहीं दिया जाता है, तो पथ को कॉन्फ़िगर किए गए डिफ़ॉल्ट locale के लिए स्थानीयकृत किया जाता है:

import { getLocalizedPath } from "intlayer";

// Configuration: defaultLocale = Locales.ENGLISH, { '/about': { en: '/about', fr: '/a-propos' } }
getLocalizedPath("/about");
// Output: "/about"

संबंधित फ़ंक्शन

• getCanonicalPath: स्थानीयकृत पथ को उसके आंतरिक canonical path में वापस हल करता है।
• getLocalizedUrl: एक पूरी तरह स्थानीयकृत URL जनरेट करता है (जिसमें protocol, host, और locale prefix शामिल हैं)।