@intlayer/docs 5.5.10 → 5.5.11

package/ar/packages/intlayer/getLocalizedUrl.md

@@ -1,221 +0,0 @@
-# توثيق: وظيفة `getLocalizedUrl` في `intlayer`
-
-## الوصف
-
-وظيفة `getLocalizedUrl` تقوم بإنشاء رابط محلي عن طريق إضافة بادئة للرابط المعطى مع اللغة المحددة. تتعامل مع الروابط المطلقة والنسبية، مما يضمن تطبيق بادئة اللغة الصحيحة بناءً على الإعدادات.
-
----
-
-## المعاملات
-
-- `url: string`
-
-  - **الوصف**: سلسلة النص الأصلية التي سيتم إضافة بادئة اللغة إليها.
-  - **النوع**: `string`
-
-- `currentLocale: Locales`
-
-  - **الوصف**: اللغة الحالية التي يتم تخصيص الرابط لها.
-  - **النوع**: `Locales`
-
-- `locales: Locales[]`
-
-  - **الوصف**: مصفوفة اختيارية من اللغات المدعومة. بشكل افتراضي، يتم توفير اللغات المكونة في المشروع.
-  - **النوع**: `Locales[]`
-  - **الافتراضي**: [`إعداد المشروع`](https://github.com/aymericzip/intlayer/blob/main/docs/ar/configuration.md#middleware)
-
-- `defaultLocale: Locales`
-
-  - **الوصف**: اللغة الافتراضية للتطبيق. بشكل افتراضي، يتم توفير اللغة الافتراضية المكونة في المشروع.
-  - **النوع**: `Locales`
-  - **الافتراضي**: [`إعداد المشروع`](https://github.com/aymericzip/intlayer/blob/main/docs/ar/configuration.md#middleware)
-
-- `prefixDefault: boolean`
-  - **الوصف**: ما إذا كان يجب إضافة بادئة للرابط للغة الافتراضية. بشكل افتراضي، يتم توفير القيمة المكونة في المشروع.
-  - **النوع**: `boolean`
-  - **الافتراضي**: [`إعداد المشروع`](https://github.com/aymericzip/intlayer/blob/main/docs/ar/configuration.md#middleware)
-
-### الإرجاع
-
-- **النوع**: `string`
-- **الوصف**: الرابط المحلي للغة المحددة.
-
----
-
-## أمثلة الاستخدام
-
-### الروابط النسبية
-
-```typescript codeFormat="typescript"
-import { getLocalizedUrl, Locales } from "intlayer";
-
-getLocalizedUrl(
-  "/about",
-  Locales.FRENCH,
-  [Locales.ENGLISH, Locales.FRENCH],
-  Locales.ENGLISH,
-  false
-);
-
-// النتيجة: "/fr/about" للغة الفرنسية
-// النتيجة: "/about" للغة الافتراضية (الإنجليزية)
-```
-
-```javascript codeFormat="esm"
-import { getLocalizedUrl, Locales } from "intlayer";
-
-getLocalizedUrl(
-  "/about",
-  Locales.FRENCH,
-  [Locales.ENGLISH, Locales.FRENCH],
-  Locales.ENGLISH,
-  false
-);
-
-// النتيجة: "/fr/about" للغة الفرنسية
-// النتيجة: "/about" للغة الافتراضية (الإنجليزية)
-```
-
-```javascript codeFormat="esm"
-import { getLocalizedUrl, Locales } from "intlayer";
-
-getLocalizedUrl(
-  "/about",
-  Locales.FRENCH,
-  [Locales.ENGLISH, Locales.FRENCH],
-  Locales.ENGLISH,
-  false
-);
-
-// النتيجة: "/fr/about" للغة الفرنسية
-// النتيجة: "/about" للغة الافتراضية (الإنجليزية)
-```
-
-```javascript codeFormat="commonjs"
-const { getLocalizedUrl, Locales } = require("intlayer");
-
-getLocalizedUrl(
-  "/about",
-  Locales.FRENCH,
-  [Locales.ENGLISH, Locales.FRENCH],
-  Locales.ENGLISH,
-  false
-);
-
-// النتيجة: "/fr/about" للغة الفرنسية
-// النتيجة: "/about" للغة الافتراضية (الإنجليزية)
-```
-
-### الروابط المطلقة
-
-```typescript
-getLocalizedUrl(
-  "https://example.com/about",
-  Locales.FRENCH, // اللغة الحالية
-  [Locales.ENGLISH, Locales.FRENCH], // اللغات المدعومة
-  Locales.ENGLISH, // اللغة الافتراضية
-  false // إضافة بادئة للغة الافتراضية
-); // النتيجة: "https://example.com/fr/about" للفرنسية
-
-getLocalizedUrl(
-  "https://example.com/about",
-  Locales.ENGLISH, // اللغة الحالية
-  [Locales.ENGLISH, Locales.FRENCH], // اللغات المدعومة
-  Locales.ENGLISH, // اللغة الافتراضية
-  false // إضافة بادئة للغة الافتراضية
-); // النتيجة: "https://example.com/about" للإنجليزية
-
-getLocalizedUrl(
-  "https://example.com/about",
-  Locales.ENGLISH, // اللغة الحالية
-  [Locales.ENGLISH, Locales.FRENCH], // اللغات المدعومة
-  Locales.ENGLISH, // اللغة الافتراضية
-  true // إضافة بادئة للغة الافتراضية
-); // النتيجة: "https://example.com/en/about" للإنجليزية
-```
-
-### لغة غير مدعومة
-
-```typescript
-getLocalizedUrl(
-  "/about",
-  Locales.ITALIAN, // اللغة الحالية
-  [Locales.ENGLISH, Locales.FRENCH], // اللغات المدعومة
-  Locales.ENGLISH // اللغة الافتراضية
-); // النتيجة: "/about" (لم يتم تطبيق بادئة للغة غير مدعومة)
-```
-
----
-
-## الحالات الخاصة
-
-- **عدم وجود مقطع لغة:**
-
-  - إذا لم يحتوي الرابط على أي مقطع لغة، تقوم الوظيفة بإضافة بادئة اللغة المناسبة بأمان.
-
-- **اللغة الافتراضية:**
-
-  - عندما تكون `prefixDefault` تساوي `false`، لا تضيف الوظيفة بادئة للرابط للغة الافتراضية.
-
-- **اللغات غير المدعومة:**
-  - بالنسبة للغات غير المدرجة في `locales`، لا تطبق الوظيفة أي بادئة.
-
----
-
-## الاستخدام في التطبيقات
-
-في تطبيق متعدد اللغات، يعد تكوين إعدادات التدويل باستخدام `locales` و `defaultLocale` أمرًا بالغ الأهمية لضمان عرض اللغة الصحيحة. فيما يلي مثال على كيفية استخدام `getLocalizedUrl` في إعداد التطبيق:
-
-```tsx codeFormat="typescript"
-import { Locales, type IntlayerConfig } from "intlayer";
-
-// تكوين اللغات المدعومة واللغة الافتراضية
-export default {
-  internationalization: {
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-    defaultLocale: Locales.ENGLISH,
-  },
-} satisfies IntlayerConfig;
-
-export default config;
-```
-
-```javascript codeFormat="esm"
-import { Locales } from "intlayer";
-
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  internationalization: {
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-    defaultLocale: Locales.ENGLISH,
-  },
-};
-
-export default config;
-```
-
-```javascript codeFormat="commonjs"
-const { Locales } = require("intlayer");
-
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  internationalization: {
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-    defaultLocale: Locales.ENGLISH,
-  },
-};
-
-module.exports = config;
-```
-
-يضمن التكوين أعلاه أن التطبيق يتعرف على `ENGLISH` و`FRENCH` و`SPANISH` كلغات مدعومة ويستخدم `ENGLISH` كلغة احتياطية.
-
-باستخدام هذا التكوين، يمكن لوظيفة `getLocalizedUrl` إنشاء روابط محلية ديناميكيًا بناءً على تفضيل لغة المستخدم:
-
-```typescript
-getLocalizedUrl("/about", Locales.FRENCH); // النتيجة: "/fr/about"
-getLocalizedUrl("/about", Locales.SPANISH); // النتيجة: "/es/about"
-getLocalizedUrl("/about", Locales.ENGLISH); // النتيجة: "/about"
-```
-
-من خلال دمج `getLocalizedUrl`، يمكن للمطورين الحفاظ على هياكل روابط متسقة عبر لغات متعددة، مما يعزز تجربة المستخدم وتحسين محركات البحث.

package/ar/packages/intlayer/getMultilingualUrls.md

@@ -1,198 +0,0 @@
-# توثيق: وظيفة `getMultilingualUrls` في `intlayer`
-
-## الوصف
-
-تقوم وظيفة `getMultilingualUrls` بإنشاء خريطة لعناوين URL متعددة اللغات عن طريق إضافة بادئة لكل لغة مدعومة إلى عنوان URL المعطى. يمكنها التعامل مع عناوين URL المطلقة والنسبية، وتطبيق بادئة اللغة المناسبة بناءً على التكوين المقدم أو الإعدادات الافتراضية.
-
----
-
-## المعلمات
-
-- `url: string`
-
-  - **الوصف**: سلسلة عنوان URL الأصلية التي سيتم إضافة بادئات اللغات إليها.
-  - **النوع**: `string`
-
-- `locales: Locales[]`
-
-  - **الوصف**: مصفوفة اختيارية من اللغات المدعومة. الافتراضي هو اللغات المكونة في المشروع.
-  - **النوع**: `Locales[]`
-  - **الافتراضي**: `localesDefault`
-
-- `defaultLocale: Locales`
-
-  - **الوصف**: اللغة الافتراضية للتطبيق. الافتراضي هو اللغة الافتراضية المكونة في المشروع.
-  - **النوع**: `Locales`
-  - **الافتراضي**: `defaultLocaleDefault`
-
-- `prefixDefault: boolean`
-  - **الوصف**: ما إذا كان يجب إضافة بادئة للغة الافتراضية. الافتراضي هو القيمة المكونة في المشروع.
-  - **النوع**: `boolean`
-  - **الافتراضي**: `prefixDefaultDefault`
-
-### الإرجاع
-
-- **النوع**: `IConfigLocales<string>`
-- **الوصف**: كائن يربط كل لغة بعنوان URL متعدد اللغات المقابل لها.
-
----
-
-## مثال على الاستخدام
-
-### عناوين URL النسبية
-
-```typescript codeFormat="typescript"
-import { getMultilingualUrls, Locales } from "intlayer";
-
-getMultilingualUrls(
-  "/dashboard",
-  [Locales.ENGLISH, Locales.FRENCH],
-  Locales.ENGLISH,
-  false
-);
-// الإخراج: {
-//   en: "/dashboard",
-//   fr: "/fr/dashboard"
-// }
-```
-
-```javascript codeFormat="esm"
-import { getMultilingualUrls, Locales } from "intlayer";
-
-getMultilingualUrls(
-  "/dashboard",
-  [Locales.ENGLISH, Locales.FRENCH],
-  Locales.ENGLISH,
-  false
-);
-// الإخراج: {
-//   en: "/dashboard",
-//   fr: "/fr/dashboard"
-// }
-```
-
-```javascript codeFormat="commonjs"
-const { getMultilingualUrls, Locales } = require("intlayer");
-
-getMultilingualUrls(
-  "/dashboard",
-  [Locales.ENGLISH, Locales.FRENCH],
-  Locales.ENGLISH,
-  false
-);
-// الإخراج: {
-//   en: "/dashboard",
-//   fr: "/fr/dashboard"
-// }
-```
-
-### عناوين URL المطلقة
-
-```typescript
-getMultilingualUrls(
-  "https://example.com/dashboard",
-  [Locales.ENGLISH, Locales.FRENCH],
-  Locales.ENGLISH,
-  true
-);
-// الإخراج: {
-//   en: "https://example.com/en/dashboard",
-//   fr: "https://example.com/fr/dashboard"
-// }
-```
-
----
-
-## الحالات الخاصة
-
-- **عدم وجود جزء للغة:**
-
-  - تقوم الوظيفة بإزالة أي جزء لغة موجود من عنوان URL قبل إنشاء الخرائط متعددة اللغات.
-
-- **اللغة الافتراضية:**
-
-  - عندما تكون `prefixDefault` تساوي `false`، لا تضيف الوظيفة بادئة للغة الافتراضية.
-
-- **اللغات غير المدعومة:**
-  - يتم النظر فقط في اللغات المقدمة في مصفوفة `locales` لإنشاء عناوين URL.
-
----
-
-## الاستخدام في التطبيقات
-
-في تطبيق متعدد اللغات، يعد تكوين إعدادات التدويل باستخدام `locales` و `defaultLocale` أمرًا بالغ الأهمية لضمان عرض اللغة الصحيحة. أدناه مثال على كيفية استخدام `getMultilingualUrls` في إعداد التطبيق:
-
-```tsx codeFormat="typescript"
-import { Locales, type IntlayerConfig } from "intlayer";
-
-// تكوين اللغات المدعومة واللغة الافتراضية
-export default {
-  internationalization: {
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-    defaultLocale: Locales.ENGLISH,
-  },
-} satisfies IntlayerConfig;
-
-export default config;
-```
-
-```javascript codeFormat="esm"
-import { Locales } from "intlayer";
-
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  internationalization: {
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-    defaultLocale: Locales.ENGLISH,
-  },
-};
-
-export default config;
-```
-
-```javascript codeFormat="commonjs"
-const { Locales } = require("intlayer");
-
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  internationalization: {
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-    defaultLocale: Locales.ENGLISH,
-  },
-};
-
-module.exports = config;
-```
-
-يضمن التكوين أعلاه أن التطبيق يتعرف على `ENGLISH` و `FRENCH` و `SPANISH` كلغات مدعومة ويستخدم `ENGLISH` كلغة احتياطية.
-
-باستخدام هذا التكوين، يمكن لوظيفة `getMultilingualUrls` إنشاء خرائط عناوين URL متعددة اللغات ديناميكيًا بناءً على اللغات المدعومة للتطبيق:
-
-```typescript
-getMultilingualUrls(
-  "/dashboard",
-  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-  Locales.ENGLISH
-);
-// الإخراج:
-// {
-//   en: "/dashboard",
-//   fr: "/fr/dashboard",
-//   es: "/es/dashboard"
-// }
-
-getMultilingualUrls(
-  "https://example.com/dashboard",
-  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-  Locales.ENGLISH,
-  true
-);
-// الإخراج:
-// {
-//   en: "https://example.com/en/dashboard",
-//   fr: "https://example.com/fr/dashboard",
-//   es: "https://example.com/es/dashboard"
-// }
-```
-
-من خلال دمج `getMultilingualUrls`، يمكن للمطورين الحفاظ على هياكل عناوين URL متسقة عبر لغات متعددة، مما يعزز تجربة المستخدم وتحسين محركات البحث.

package/ar/packages/intlayer/getPathWithoutLocale.md

@@ -1,50 +0,0 @@
-# Documentation: `getPathWithoutLocale` وظائف في `intlayer`
-
-## الوصف
-
-يزيل الجزء الخاص باللغة من عنوان URL أو المسار المحدد إذا كان موجودًا. يعمل مع عناوين URL المطلقة والمسارات النسبية.
-
-## المعلمات
-
-- `inputUrl: string`
-
-  - **الوصف**: سلسلة عنوان URL الكاملة أو المسار لمعالجتها.
-  - **النوع**: `string`
-
-- `locales: Locales[]`
-  - **الوصف**: مصفوفة اختيارية من اللغات المدعومة. الافتراضي هو اللغات المكونة في المشروع.
-  - **النوع**: `Locales[]`
-
-## الإرجاع
-
-- **النوع**: `string`
-- **الوصف**: سلسلة عنوان URL أو المسار بدون الجزء الخاص باللغة.
-
-## مثال على الاستخدام
-
-```typescript codeFormat="typescript"
-import { getPathWithoutLocale } from "intlayer";
-
-console.log(getPathWithoutLocale("/dashboard")); // الناتج: "/dashboard"
-console.log(getPathWithoutLocale("/en/dashboard")); // الناتج: "/dashboard"
-console.log(getPathWithoutLocale("/fr/dashboard")); // الناتج: "/dashboard"
-console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // الناتج: "https://example.com/dashboard"
-```
-
-```javascript codeFormat="esm"
-import { getPathWithoutLocale } from "intlayer";
-
-console.log(getPathWithoutLocale("/dashboard")); // الناتج: "/dashboard"
-console.log(getPathWithoutLocale("/en/dashboard")); // الناتج: "/dashboard"
-console.log(getPathWithoutLocale("/fr/dashboard")); // الناتج: "/dashboard"
-console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // الناتج: "https://example.com/dashboard"
-```
-
-```javascript codeFormat="commonjs"
-const { getPathWithoutLocale } = require("intlayer");
-
-console.log(getPathWithoutLocale("/dashboard")); // الناتج: "/dashboard"
-console.log(getPathWithoutLocale("/en/dashboard")); // الناتج: "/dashboard"
-console.log(getPathWithoutLocale("/fr/dashboard")); // الناتج: "/dashboard"
-console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // الناتج: "https://example.com/dashboard"
-```

package/ar/packages/intlayer/getTranslation.md

@@ -1,175 +0,0 @@
-# التوثيق: وظيفة `getTranslationContent` في `intlayer`
-
-## الوصف
-
-تقوم وظيفة `getTranslationContent` باسترجاع المحتوى المقابل للغة معينة من مجموعة محتوى لغوي قابل للتخصيص. إذا لم يتم العثور على اللغة المحددة، فإنها تعود افتراضيًا إلى إرجاع المحتوى الخاص باللغة الافتراضية المكونة في المشروع.
-
-## المعاملات
-
-- `languageContent: CustomizableLanguageContent<Content>`
-
-  - **الوصف**: كائن يحتوي على الترجمات للغات مختلفة. كل مفتاح يمثل لغة، وقيمته هي المحتوى المقابل.
-  - **النوع**: `CustomizableLanguageContent<Content>`
-    - `Content` يمكن أن يكون أي نوع، والافتراضي هو `string`.
-
-- `locale: Locales`
-
-  - **الوصف**: اللغة التي سيتم استرجاع المحتوى الخاص بها.
-  - **النوع**: `Locales`
-
-## الإرجاع
-
-- **النوع**: `Content`
-- **الوصف**: المحتوى المقابل للغة المحددة. إذا لم يتم العثور على اللغة، يتم إرجاع محتوى اللغة الافتراضية.
-
-## مثال على الاستخدام
-
-### الاستخدام الأساسي
-
-```typescript codeFormat="typescript"
-import { getTranslationContent, Locales } from "intlayer";
-
-const content = getTranslationContent(
-  {
-    en: "Hello",
-    fr: "Bonjour",
-    ar: "مرحبًا",
-  },
-  Locales.ENGLISH
-);
-
-console.log(content); // Output: "Hello"
-```
-
-```javascript codeFormat="esm"
-import { getTranslationContent, Locales } from "intlayer";
-
-const content = getTranslationContent(
-  {
-    en: "Hello",
-    fr: "Bonjour",
-    ar: "مرحبًا",
-  },
-  Locales.ENGLISH
-);
-
-console.log(content); // Output: "Hello"
-```
-
-```javascript codeFormat="commonjs"
-const { getTranslationContent, Locales } = require("intlayer");
-
-const content = getTranslationContent(
-  {
-    en: "Hello",
-    fr: "Bonjour",
-    ar: "مرحبًا",
-  },
-  Locales.ENGLISH
-);
-
-console.log(content); // Output: "Hello"
-```
-
-### لغة مفقودة:
-
-```typescript codeFormat="typescript"
-import { getTranslationContent, Locales } from "intlayer";
-
-const content = getTranslationContent(
-  {
-    en: "Hello",
-    fr: "Bonjour",
-    ar: "مرحبًا",
-  },
-  Locales.SPANISH
-);
-
-console.log(content); // Output: "Hello" (محتوى اللغة الافتراضية)
-```
-
-```javascript codeFormat="esm"
-import { getTranslationContent, Locales } from "intlayer";
-
-const content = getTranslationContent(
-  {
-    en: "Hello",
-    fr: "Bonjour",
-    ar: "مرحبًا",
-  },
-  Locales.SPANISH
-);
-
-console.log(content); // Output: "Hello" (محتوى اللغة الافتراضية)
-```
-
-```javascript codeFormat="commonjs"
-const { getTranslationContent, Locales } = require("intlayer");
-
-const content = getTranslationContent(
-  {
-    en: "Hello",
-    fr: "Bonjour",
-    ar: "مرحبًا",
-  },
-  Locales.SPANISH
-);
-
-console.log(content); // Output: "Hello" (محتوى اللغة الافتراضية)
-```
-
-### استخدام أنواع محتوى مخصصة:
-
-```typescript codeFormat="typescript"
-import { getTranslationContent, Locales } from "intlayer";
-
-const customContent = getTranslationContent<Record<string, string>>(
-  {
-    en: { greeting: "Hello" },
-    fr: { greeting: "Bonjour" },
-    ar: { greeting: "مرحبًا" },
-  },
-  Locales.FRENCH
-);
-
-console.log(customContent.greeting); // Output: "Bonjour"
-```
-
-```javascript codeFormat="esm"
-import { getTranslationContent, Locales } from "intlayer";
-
-const customContent = getTranslationContent<Record<string, string>>(
-  {
-    en: { greeting: "Hello" },
-    fr: { greeting: "Bonjour" },
-    ar: { greeting: "مرحبًا" },
-  },
-  Locales.FRENCH
-);
-
-console.log(customContent.greeting); // Output: "Bonjour"
-```
-
-```javascript codeFormat="commonjs"
-const { getTranslationContent, Locales } = require("intlayer");
-
-const customContent = getTranslationContent<Record<string, string>>(
-  {
-    en: { greeting: "Hello" },
-    fr: { greeting: "Bonjour" },
-    ar: { greeting: "مرحبًا" },
-  },
-  Locales.FRENCH
-);
-
-console.log(customContent.greeting); // Output: "Bonjour"
-```
-
-## الحالات الخاصة
-
-- **اللغة غير موجودة:**
-  - عندما لا يتم العثور على `locale` في `languageContent`، تقوم الوظيفة بإرجاع المحتوى الخاص باللغة الافتراضية.
-- **محتوى لغوي غير مكتمل:**
-  - إذا كانت اللغة معرفة جزئيًا، فإن الوظيفة لا تدمج المحتويات. تسترجع فقط القيمة الخاصة باللغة المحددة أو تعود إلى الافتراضية.
-- **فرض TypeScript:**
-  - إذا لم تتطابق اللغات في `languageContent` مع تكوين المشروع، فإن TypeScript يفرض تعريف جميع اللغات المطلوبة، مما يضمن أن المحتوى كامل وآمن من حيث النوع.