التوثيق: دالة getPrefix في intlayer

getPrefix(
  locale: Locales,               // مطلوب
  options?: {                    // اختياري
    defaultLocale?: Locales;
    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
  }
): GetPrefixResult

type GetPrefixResult = {
  prefix: string;   // مثال: 'fr/' أو ''
  localePrefix?: Locale; // مثال: 'fr' أو undefined
}

import { getPrefix, Locales } from "intlayer";

// تحقق من البادئة للغة الإنجليزية
getPrefix(Locales.ENGLISH, {
  defaultLocale: Locales.ENGLISH,
  mode: "prefix-all",
});
// يعيد: { prefix: 'en/', localePrefix: 'en' }

// تحقق من البادئة للغة الفرنسية
getPrefix(Locales.FRENCH, {
  defaultLocale: Locales.ENGLISH,
  mode: "prefix-no-default",
});
// يعيد: { prefix: 'fr/', localePrefix: 'fr' }

import { getPrefix, Locales } from "intlayer";

// prefix-all: يعيد البادئة دائمًا
getPrefix(Locales.ENGLISH, {
  mode: "prefix-all",
  defaultLocale: Locales.ENGLISH,
});
// يعيد: { prefix: '/en', localePrefix: 'en' }

// prefix-no-default: لا يعيد بادئة عندما تتطابق اللغة مع الافتراضية
getPrefix(Locales.ENGLISH, {
  mode: "prefix-no-default",
  defaultLocale: Locales.ENGLISH,
});
// يعيد: { prefix: '', localePrefix: undefined }

// prefix-no-default: يعيد البادئة عندما تختلف اللغة عن اللغة الافتراضية
getPrefix(Locales.FRENCH, {
  mode: "prefix-no-default",
  defaultLocale: Locales.ENGLISH,
});
// يعيد: { prefix: 'fr/', localePrefix: 'fr' }

// no-prefix & search-params: لا يعيد البادئة أبدًا
getPrefix(Locales.ENGLISH, { mode: "no-prefix" });
// يعيد: { prefix: '', localePrefix: undefined }

getPrefix(Locales.ENGLISH, { mode: "search-params" });
// يعيد: { prefix: '', localePrefix: undefined }

import { getPrefix, Locales } from "intlayer";

// بناء عناوين URL مع البادئة المناسبة للغة معينة
const locale = Locales.FRENCH;
const { prefix, localePrefix } = getPrefix(locale, {
  defaultLocale: Locales.ENGLISH,
  mode: "prefix-no-default",
});

// استخدام البادئة لبناء المسار
const url1 = `/${prefix}about`.replace(/\/+/g, "/");
// النتيجة: "/fr/about"

// استخدام localePrefix لتحديد اللغة
console.log(`Current locale: ${localePrefix}`);
// المخرجات: "Current locale: fr"

type GetPrefixResult = {
  prefix: string; // بادئة المسار مع الشرطة المائلة النهائية (مثلاً 'fr/' أو '')
  localePrefix?: Locale; // معرف اللغة بدون شرطات مائلة (مثلاً 'fr' أو غير معرف)
};

function getPrefix(
  locale: Locales,
  options?: {
    defaultLocale?: Locales;
    mode?: "prefix-no-default" | "prefix-all" | "no-prefix" | "search-params";
  }
): GetPrefixResult;