@intlayer/docs 5.5.8

package/en/packages/intlayer/getPathWithoutLocale.md

@@ -0,0 +1,50 @@
+# Documentation: `getPathWithoutLocale` Functions in `intlayer`
+
+## Description
+
+Removes the locale segment from the given URL or pathname if present. It works with both absolute URLs and relative pathnames.
+
+## Parameters
+
+- `inputUrl: string`
+
+  - **Description**: The complete URL string or pathname to process.
+  - **Type**: `string`
+
+- `locales: Locales[]`
+  - **Description**: Optional array of supported locales. Defaults to the configured locales in the project.
+  - **Type**: `Locales[]`
+
+## Returns
+
+- **Type**: `string`
+- **Description**: The URL string or pathname without the locale segment.
+
+## Example Usage
+
+```typescript codeFormat="typescript"
+import { getPathWithoutLocale } from "intlayer";
+
+console.log(getPathWithoutLocale("/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Output: "https://example.com/dashboard"
+```
+
+```javascript codeFormat="esm"
+import { getPathWithoutLocale } from "intlayer";
+
+console.log(getPathWithoutLocale("/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Output: "https://example.com/dashboard"
+```
+
+```javascript codeFormat="commonjs"
+const { getPathWithoutLocale } = require("intlayer");
+
+console.log(getPathWithoutLocale("/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Output: "https://example.com/dashboard"
+```

package/en/packages/intlayer/getTranslation.md

@@ -0,0 +1,166 @@
+# Documentation: `getTranslationContent` Function in `intlayer`
+
+## Description
+
+The `getTranslationContent` function retrieves the content corresponding to a specific locale from a set of customizable language content. If the specified locale is not found, it defaults to returning the content for the default locale configured in the project.
+
+## Parameters
+
+- `languageContent: CustomizableLanguageContent<Content>`
+
+  - **Description**: An object containing translations for various locales. Each key represents a locale, and its value is the corresponding content.
+  - **Type**: `CustomizableLanguageContent<Content>`
+    - `Content` can be any type, defaulting to `string`.
+
+- `locale: Locales`
+
+  - **Description**: The locale for which content is to be retrieved.
+  - **Type**: `Locales`
+
+## Returns
+
+- **Type**: `Content`
+- **Description**: The content corresponding to the specified locale. If the locale is not found, the content of the default locale is returned.
+
+## Example Usage
+
+### Basic Usage
+
+```typescript codeFormat="typescript"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Output: "Bonjour"
+```
+
+```javascript codeFormat="esm"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Output: "Bonjour"
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslationContent, Locales } = require("intlayer");
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Output: "Bonjour"
+```
+
+### Missing Locale:
+
+```typescript codeFormat="typescript"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Output: "Hello" (default locale content)
+```
+
+```javascript codeFormat="esm"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Output: "Hello" (default locale content)
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslationContent, Locales } = require("intlayer");
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Output: "Hello" (default locale content)
+```
+
+### Using Custom Content Types:
+
+```typescript codeFormat="typescript"
+import { getTranslationContent, Locales } from "intlayer";
+
+const customContent = getTranslationContent<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+  },
+  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" },
+  },
+  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" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Output: "Bonjour"
+```
+
+## Edge Cases
+
+- **Locale Not Found:**
+  - When the `locale` is not found in the `languageContent`, the function returns the content for the default locale.
+- **Incomplete Language Content:**
+  - If a locale is partially defined, the function does not merge contents. It strictly retrieves the value of the specified locale or falls back to the default.
+- **TypeScript Enforcement:**
+  - If the locales in `languageContent` do not match the project configuration, TypeScript will enforce all required locales to be defined, ensuring the content is complete and type-safe.

package/en/packages/intlayer/getTranslationContent.md

@@ -0,0 +1,166 @@
+# Documentation: `getTranslation` Function in `intlayer`
+
+## Description
+
+The `getTranslation` function retrieves the content corresponding to a specific locale from a set of customizable language content. If the specified locale is not found, it defaults to returning the content for the default locale configured in the project.
+
+## Parameters
+
+- `languageContent: CustomizableLanguageContent<Content>`
+
+  - **Description**: An object containing translations for various locales. Each key represents a locale, and its value is the corresponding content.
+  - **Type**: `CustomizableLanguageContent<Content>`
+    - `Content` can be any type, defaulting to `string`.
+
+- `locale: Locales`
+
+  - **Description**: The locale for which content is to be retrieved.
+  - **Type**: `Locales`
+
+## Returns
+
+- **Type**: `Content`
+- **Description**: The content corresponding to the specified locale. If the locale is not found, the content of the default locale is returned.
+
+## Example Usage
+
+### Basic Usage
+
+```typescript codeFormat="typescript"
+import { getTranslation, Locales } from "intlayer";
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Output: "Bonjour"
+```
+
+```javascript codeFormat="esm"
+import { getTranslation, Locales } from "intlayer";
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Output: "Bonjour"
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslation, Locales } = require("intlayer");
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Output: "Bonjour"
+```
+
+### Missing Locale:
+
+```typescript codeFormat="typescript"
+import { getTranslation, Locales } from "intlayer";
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Output: "Hello" (default locale content)
+```
+
+```javascript codeFormat="esm"
+import { getTranslation, Locales } from "intlayer";
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Output: "Hello" (default locale content)
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslation, Locales } = require("intlayer");
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Output: "Hello" (default locale content)
+```
+
+### Using Custom Content Types:
+
+```typescript codeFormat="typescript"
+import { getTranslation, Locales } from "intlayer";
+
+const customContent = getTranslation<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Output: "Bonjour"
+```
+
+```javascript codeFormat="esm"
+import { getTranslation, Locales } from "intlayer";
+
+const customContent = getTranslation<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Output: "Bonjour"
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslation, Locales } = require("intlayer");
+
+const customContent = getTranslation<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Output: "Bonjour"
+```
+
+## Edge Cases
+
+- **Locale Not Found:**
+  - When the `locale` is not found in the `languageContent`, the function returns the content for the default locale.
+- **Incomplete Language Content:**
+  - If a locale is partially defined, the function does not merge contents. It strictly retrieves the value of the specified locale or falls back to the default.
+- **TypeScript Enforcement:**
+  - If the locales in `languageContent` do not match the project configuration, TypeScript will enforce all required locales to be defined, ensuring the content is complete and type-safe.