Dokümantasyon: intlayer'de getCanonicalPath Fonksiyonu

Açıklama

getCanonicalPath fonksiyonu yerelleştirilmiş bir URL yolunu (ör. /a-propos) dahili kanonik uygulama yoluna (ör. /about) çözer. Bu, yönlendiricilerin URL dilinden bağımsız olarak doğru dahili rotayı eşlemesi için gereklidir.

Ana Özellikler:

• [param] sözdizimini kullanarak dinamik rota parametrelerini destekler.
• Yerelleştirilmiş yolları, yapılandırmanızda tanımlı özel yeniden yazma kurallarıyla eşleştirir.
• Eşleşen bir yeniden yazma kuralı bulunamazsa orijinal yolu döndürür.

Fonksiyon İmzası

getCanonicalPath(
  localizedPath: string,         // Gerekli
  locale: Locales,               // Gerekli
  rewriteRules?: RoutingConfig['rewrite'] // Opsiyonel
): string

Parametreler

Gerekli Parametreler

• localizedPath: string

  • Açıklama: Tarayıcıda görülen yerelleştirilmiş yol (ör. /a-propos).
  • Tür: string
  • Gerekli: Evet

• locale: Locales

  • Açıklama: Çözülmekte olan yol için kullanılan yerel ayar.
  • Tür: Locales
  • Gerekli: Evet

Opsiyonel Parametreler

• rewriteRules?: RoutingConfig['rewrite']
  • Açıklama: Özelleştirilmiş yeniden yazma kurallarını tanımlayan bir nesne. Sağlanmazsa, proje konfigürasyonunuzdaki routing.rewrite özelliği varsayılan olarak kullanılır.
  • Tür: RoutingConfig['rewrite']
  • Varsayılan: configuration.routing.rewrite

Döndürülen Değer

• Tür: string
• Açıklama: Dahili kanonik yol.

Örnek Kullanım

Temel Kullanım (Konfigürasyon ile)

Eğer intlayer.config.ts dosyanızda özel yeniden yazma kuralları yapılandırdıysanız:

import { getCanonicalPath, Locales } from "intlayer";

// Konfigürasyon: { '/about': { en: '/about', fr: '/a-propos' } }
getCanonicalPath("/a-propos", Locales.FRENCH);
// Çıktı: "/about"

getCanonicalPath("/about", Locales.ENGLISH);
// Çıktı: "/about"

Dinamik Rotalarla Kullanım

import { getCanonicalPath, Locales } from "intlayer";

// Konfigürasyon: { '/product/[id]': { en: '/product/[id]', fr: '/produit/[id]' } }
getCanonicalPath("/produit/123", Locales.FRENCH);
// Çıktı: "/product/123"

Manuel Yeniden Yazma Kuralları

Ayrıca fonksiyona manuel yeniden yazma kuralları da geçirebilirsiniz:

import { getCanonicalPath, Locales } from "intlayer";

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

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

İlgili Fonksiyonlar

• getLocalizedPath: Bir canonical path'i yerelleştirilmiş eşdeğerine çözer.
• getLocalizedUrl: Tamamen yerelleştirilmiş bir URL üretir (protokol, host ve locale öneki dahil).