@intlayer/docs 7.1.0-canary.0 → 7.1.0-canary.1

package/docs/en/packages/intlayer/getPrefix.md

@@ -28,13 +28,13 @@ history:
 
 ## Description
 
-The `getPrefix` function determines the URL prefix for a given locale based on the routing mode configuration. It compares the locale with the default locale and returns the appropriate prefix string (e.g., `'en/'`) or an empty string.
+The `getPrefix` function determines the URL prefix for a given locale based on the routing mode configuration. It compares the locale with the default locale and returns the appropriate prefix string (e.g., `'en/'`, `'fr/'`) or an empty string.
 
 **Key Features:**
 
-- Takes a locale as the first parameter (optional)
+- Takes a locale as the first parameter (required)
 - Optional `options` object with `defaultLocale`, `mode`, and `addSlash`
-- Returns a prefix string that can be used for URL construction
+- Returns a prefix string based on the provided locale that can be used for URL construction
 - Supports all routing modes: `prefix-no-default`, `prefix-all`, `no-prefix`, and `search-params`
 - Lightweight utility for determining when to add locale prefixes
 
@@ -44,7 +44,7 @@ The `getPrefix` function determines the URL prefix for a given locale based on t
 
 ```typescript
 getPrefix(
-  locale?: Locales,              // Optional
+  locale: Locales,               // Required
   options?: {                    // Optional
     defaultLocale?: Locales;
     mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
@@ -57,13 +57,10 @@ getPrefix(
 
 ## Parameters
 
-### Optional Parameters
-
-- `locale?: Locales`
-  - **Description**: The locale to check for prefix. If not provided, uses the configured default locale.
+- `locale: Locales`
+  - **Description**: The locale to generate the prefix for. If the value is falsy (undefined, null, empty string), the function returns an empty string.
   - **Type**: `Locales`
-  - **Required**: No (Optional)
-  - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md#middleware)
+  - **Required**: Yes
 
 - `options?: object`
   - **Description**: Configuration object for prefix determination.
@@ -93,7 +90,7 @@ getPrefix(
 ### Returns
 
 - **Type**: `string`
-- **Description**: The prefix string for the default locale (e.g., `'en/'`, `'fr/'`) or an empty string.
+- **Description**: The prefix string for the given locale (e.g., `'en/'`, `'fr/'`) or an empty string depending on the routing mode and whether the locale matches the default.
 
 ---
 
@@ -116,7 +113,7 @@ getPrefix(Locales.FRENCH, {
   defaultLocale: Locales.ENGLISH,
   mode: "prefix-no-default",
 });
-// Returns: 'en/'
+// Returns: 'fr/'
 ```
 
 ```javascript codeFormat="esm"
@@ -155,7 +152,7 @@ getPrefix(Locales.FRENCH, {
   mode: "prefix-no-default",
   defaultLocale: Locales.ENGLISH,
 });
-// Returns: "en/"
+// Returns: "fr/"
 
 // no-prefix & search-params: Never returns prefix
 getPrefix(Locales.ENGLISH, { mode: "no-prefix" }); // Returns: ""
@@ -173,9 +170,12 @@ import { getPrefix, Locales } from "intlayer";
 
 // Build URLs with the appropriate prefix for a specific locale
 const locale = Locales.FRENCH;
-const prefix = getPrefix(locale, { defaultLocale: Locales.ENGLISH });
+const prefix = getPrefix(locale, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
 const url = `/${prefix}about`.replace(/\/+/g, "/");
-// Result: "/en/about" if French is not default
+// Result: "/fr/about" (because French differs from default English)
 ```
 
 ---
@@ -191,7 +191,7 @@ const url = `/${prefix}about`.replace(/\/+/g, "/");
 
 ```typescript
 function getPrefix(
-  locale?: Locales,
+  locale: Locales,
   options?: {
     defaultLocale?: Locales;
     mode?: "prefix-no-default" | "prefix-all" | "no-prefix" | "search-params";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/docs",
-  "version": "7.1.0-canary.0",
+  "version": "7.1.0-canary.1",
   "private": false,
   "description": "Intlayer documentation",
   "keywords": [
@@ -72,13 +72,13 @@
     "watch": "webpack --config ./webpack.config.ts --watch"
   },
   "dependencies": {
-    "@intlayer/config": "7.1.0-canary.0",
-    "@intlayer/core": "7.1.0-canary.0",
-    "@intlayer/types": "7.1.0-canary.0"
+    "@intlayer/config": "7.1.0-canary.1",
+    "@intlayer/core": "7.1.0-canary.1",
+    "@intlayer/types": "7.1.0-canary.1"
   },
   "devDependencies": {
-    "@intlayer/api": "7.1.0-canary.0",
-    "@intlayer/cli": "7.1.0-canary.0",
+    "@intlayer/api": "7.1.0-canary.1",
+    "@intlayer/cli": "7.1.0-canary.1",
     "@types/node": "24.10.1",
     "@utils/ts-config": "1.0.4",
     "@utils/ts-config-types": "1.0.4",
@@ -91,11 +91,11 @@
     "vitest": "4.0.8"
   },
   "peerDependencies": {
-    "@intlayer/api": "7.1.0-canary.0",
-    "@intlayer/cli": "7.1.0-canary.0",
-    "@intlayer/config": "7.1.0-canary.0",
-    "@intlayer/core": "7.1.0-canary.0",
-    "@intlayer/types": "7.1.0-canary.0"
+    "@intlayer/api": "7.1.0-canary.1",
+    "@intlayer/cli": "7.1.0-canary.1",
+    "@intlayer/config": "7.1.0-canary.1",
+    "@intlayer/core": "7.1.0-canary.1",
+    "@intlayer/types": "7.1.0-canary.1"
   },
   "engines": {
     "node": ">=14.18"