@intlayer/docs 7.5.12 → 7.5.14

package/docs/uk/packages/intlayer/getMultilingualUrls.md

@@ -0,0 +1,359 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-11-16
+title: Документація функції getMultilingualUrls | intlayer
+description: Дізнайтеся, як використовувати функцію getMultilingualUrls у пакеті intlayer
+keywords:
+  - getMultilingualUrls
+  - переклад
+  - Intlayer
+  - intlayer
+  - інтернаціоналізація
+  - документація
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getMultilingualUrls
+history:
+  - version: 7.1.0
+    date: 2025-11-16
+    changes: Refactored to use options parameter with mode instead of prefixDefault
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
+---
+
+# Документація: функція `getMultilingualUrls` в `intlayer`
+
+## Опис
+
+Функція `getMultilingualUrls` генерує відображення багатомовних URL, додаючи префікс локалі до заданого URL для кожної підтримуваної локалі. Вона може обробляти як абсолютні, так і відносні URL, застосовуючи відповідний префікс локалі на основі наданої конфігурації або значень за замовчуванням.
+
+**Ключові особливості:**
+
+- Потрібен лише один параметр: `url`
+- Необов'язковий об'єкт `options` з полями `locales`, `defaultLocale` та `mode`
+- Використовує конфігурацію інтернаціоналізації вашого проєкту за замовчуванням
+- Підтримує кілька режимів маршрутизації: `prefix-no-default`, `prefix-all`, `no-prefix` та `search-params`
+- Повертає об'єкт-мапу, де ключами є всі локалі, а значеннями — відповідні URL
+
+---
+
+## Підпис функції
+
+```typescript
+getMultilingualUrls(
+  url: string,                   // Обов'язково
+  options?: {                    // Необов'язково
+    locales?: Locales[];
+    defaultLocale?: Locales;
+    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
+  }
+): StrictModeLocaleMap<string>
+```
+
+---
+
+## Параметри
+
+### Обов'язкові параметри
+
+- `url: string`
+  - **Опис**: Початковий рядок URL, до якого будуть додані префікси локалей.
+  - **Тип**: `string`
+  - **Обов'язково**: Так
+
+### Необов'язкові параметри
+
+- `options?: object`
+  - **Опис**: Об'єкт конфігурації для поведінки локалізації URL.
+  - **Тип**: `object`
+  - **Обов'язково**: Ні (Необов'язково)
+
+  - `options.locales?: Locales[]`
+    - **Опис**: Масив підтримуваних локалей. Якщо не вказано, використовуються налаштовані локалі з конфігурації вашого проєкту.
+    - **Тип**: `Locales[]`
+    - **За замовчуванням**: [`Конфігурація проєкту`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/configuration.md#middleware)
+
+  - `options.defaultLocale?: Locales`
+    - **Опис**: Мова за замовчуванням для додатка. Якщо не вказано, використовується мова за замовчуванням, налаштована у конфігурації вашого проєкту.
+    - **Тип**: `Locales`
+    - **За замовчуванням**: [`Конфігурація проєкту`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/configuration.md#middleware)
+
+  - `options.mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Опис**: Режим маршрутизації URL для обробки локалі. Якщо не вказано, використовується режим, налаштований у конфігурації вашого проєкту.
+    - **Тип**: `'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **За замовчуванням**: [`Конфігурація проєкту`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/configuration.md#middleware)
+    - **Режими**:
+      - `prefix-no-default`: Без префікса для мови за замовчуванням, префікс для всіх інших
+      - `prefix-all`: Префікс для всіх мов, включно зі мовою за замовчуванням
+      - `no-prefix`: Немає префікса локалі в URL
+      - `search-params`: Використовувати параметри запиту для локалі (наприклад, `?locale=fr`)
+
+### Повертає
+
+- **Тип**: `StrictModeLocaleMap<string>`
+- **Опис**: Об'єкт, який зіставляє кожну локаль з відповідним багатомовним URL.
+
+---
+
+## Приклад використання
+
+### Базове використання (використовує конфігурацію проєкту)
+
+```typescript codeFormat="typescript"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+// Використовує конфігурацію вашого проєкту для locales, defaultLocale і mode
+getMultilingualUrls("/dashboard");
+// Вивід (припускаючи, що в конфігурації проєкту є en і fr з mode 'prefix-no-default'):
+// {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="esm"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls("/dashboard");
+// Вивід: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="commonjs"
+const { getMultilingualUrls, Locales } = require("intlayer");
+
+getMultilingualUrls("/dashboard");
+// Вивід: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+### Відносні URL з опціями
+
+```typescript codeFormat="typescript"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// Вивід: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="esm"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// Вивід: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="commonjs"
+const { getMultilingualUrls, Locales } = require("intlayer");
+
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// Вивід: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+### Абсолютні URL-адреси
+
+```typescript
+getMultilingualUrls("https://example.com/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-all",
+});
+// Вивід: {
+//   en: "https://example.com/en/dashboard",
+//   fr: "https://example.com/fr/dashboard"
+// }
+```
+
+### Різні режими маршрутизації
+
+```typescript
+// prefix-no-default: Без префіксу для локалі за замовчуванням
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// Вивід: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+// prefix-all: Префікс для всіх локалей
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-all",
+});
+// Вихід: {
+//   en: "/en/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+// no-prefix: Відсутній префікс локалі в URL
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "no-prefix",
+});
+// Вихід: {
+//   en: "/dashboard",
+//   fr: "/dashboard",
+//   es: "/dashboard"
+// }
+
+// search-params: Локаль як параметр запиту
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "search-params",
+});
+// Вихід: {
+//   en: "/dashboard?locale=en",
+//   fr: "/dashboard?locale=fr",
+//   es: "/dashboard?locale=es"
+// }
+```
+
+---
+
+## Крайні випадки
+
+- **Відсутній сегмент локалі:**
+  - Функція видаляє будь-який існуючий сегмент локалі з URL перед генерацією багатомовних відповідностей.
+
+- **Локаль за замовчуванням:**
+  - Коли `mode` дорівнює `'prefix-no-default'`, функція не додає префікс до URL для локалі за замовчуванням.
+  - Коли `mode` дорівнює `'prefix-all'`, функція додає префікси для всіх локалей, включно з локаллю за замовчуванням.
+
+- **Непідтримувані локалі:**
+  - Лише локалі, вказані в масиві locales, враховуються під час генерації URL.
+
+- **Режими маршрутизації:**
+  - `'prefix-no-default'`: для локалі за замовчуванням префікс відсутній, для інших — є (наприклад, `/dashboard`, `/fr/dashboard`)
+  - `'prefix-all'`: усі локалі мають префікси (наприклад, `/en/dashboard`, `/fr/dashboard`)
+  - `'no-prefix'`: Немає префіксів локалі в URL (для всіх локалей повертається той самий URL)
+  - `'search-params'`: Локаль вказується через параметр запиту (наприклад, `/dashboard?locale=fr`)
+
+---
+
+## Використання в застосунках
+
+У багатомовному застосунку налаштування параметрів інтернаціоналізації через `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");
+// Вивід:
+// {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+// З явними опціями
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// Вивід:
+// {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+// Абсолютні URL з режимом "prefix-all"
+getMultilingualUrls("https://example.com/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-all",
+});
+// Вивід:
+// {
+//   en: "https://example.com/en/dashboard",
+//   fr: "https://example.com/fr/dashboard",
+//   es: "https://example.com/es/dashboard"
+// }
+```
+
+Інтегруючи `getMultilingualUrls`, розробники можуть підтримувати узгоджену структуру URL для кількох мов, що покращує як досвід користувача, так і SEO.

package/docs/uk/packages/intlayer/getPathWithoutLocale.md

@@ -0,0 +1,75 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Документація функції getPathWithoutLocale | intlayer
+description: Дивіться, як використовувати функцію getPathWithoutLocale для пакета intlayer
+keywords:
+  - getPathWithoutLocale
+  - переклад
+  - Intlayer
+  - intlayer
+  - інтернаціоналізація
+  - документація
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getPathWithoutLocale
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
+---
+
+# Документація: Функції `getPathWithoutLocale` у `intlayer`
+
+## Опис
+
+Видаляє сегмент локалі з вказаного URL або pathname, якщо він присутній. Працює як з абсолютними URL, так і з відносними шляхами.
+
+## Параметри
+
+- `inputUrl: string`
+  - **Опис**: Повний рядок URL або шлях (pathname) для обробки.
+  - **Тип**: `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/docs/uk/packages/intlayer/getPrefix.md

@@ -0,0 +1,213 @@
+---
+createdAt: 2025-11-16
+updatedAt: 2025-11-16
+title: Документація функції getPrefix | intlayer
+description: Дивіться, як використовувати функцію getPrefix для пакета intlayer
+keywords:
+  - getPrefix
+  - prefix
+  - Intlayer
+  - intlayer
+  - Інтернаціоналізація
+  - Документація
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getPrefix
+history:
+  - version: 7.1.0
+    date: 2025-11-16
+    changes: Початкова документація
+---
+
+# Документація: функція `getPrefix` в `intlayer`
+
+## Опис
+
+Функція `getPrefix` визначає префікс URL для заданої локалі на основі конфігурації режиму маршрутизації. Вона порівнює локаль з локаллю за замовчуванням і повертає об'єкт, що містить три різні формати префіксів для гнучкого побудови URL.
+
+**Ключові особливості:**
+
+- Приймає локаль як перший параметр (обов'язково)
+- Необов'язковий об'єкт `options` з полями `defaultLocale` та `mode`
+- Повертає об'єкт з властивостями `prefix` та `localePrefix`
+- Підтримує всі режими маршрутизації: `prefix-no-default`, `prefix-all`, `no-prefix` та `search-params`
+- Легка утиліта для визначення, коли додавати префікси локалі
+
+---
+
+## Підпис функції
+
+```typescript
+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
+}
+```
+
+---
+
+## Параметри
+
+- `locale: Locales`
+  - **Опис**: Локаль, для якої потрібно згенерувати префікс. Якщо значення є falsy (undefined, null, порожній рядок), функція повертає порожній рядок.
+  - **Тип**: `Locales`
+  - **Обов'язкове**: Так
+
+- `options?: object`
+  - **Опис**: Об'єкт конфігурації для визначення префіксу.
+  - **Тип**: `object`
+  - **Обов'язкове**: Ні (Необов'язково)
+
+  - `options.defaultLocale?: Locales`
+    - **Опис**: Локаль за замовчуванням для застосунку. Якщо не вказано, використовується налаштована локаль за замовчуванням з конфігурації вашого проєкту.
+    - **Тип**: `Locales`
+    - **За замовчуванням**: [`Конфігурація проєкту`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/configuration.md#middleware)
+
+  - `options.mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Опис**: Режим маршрутизації URL для обробки локалі. Якщо не вказано, використовується режим, налаштований у конфігурації вашого проєкту.
+    - **Тип**: `'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **За замовчуванням**: [`Конфігурація проєкту`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/configuration.md#middleware)
+    - **Режими**:
+      - `prefix-no-default`: Повертає порожні рядки, коли локаль збігається з локаллю за замовчуванням
+      - `prefix-all`: Повертає префікс для всіх локалей, включно з локаллю за замовчуванням
+      - `no-prefix`: Повертає порожні рядки (без префікса в URL)
+      - `search-params`: Повертає порожні рядки (локаль у параметрах запиту)
+
+### Повертає
+
+- **Тип**: `GetPrefixResult`
+- **Опис**: Об'єкт, що містить три різні формати префіксів:
+  - `prefix`: Префікс шляху з кінцевим слешем (наприклад, `'fr/'`, `''`)
+  - `localePrefix`: Ідентифікатор локалі без слешів (наприклад, `'fr'`, `undefined`)
+
+---
+
+## Приклад використання
+
+### Базове використання
+
+```typescript codeFormat="typescript"
+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' }
+```
+
+```javascript codeFormat="esm"
+import { getPrefix, Locales } from "intlayer";
+
+getPrefix(Locales.ENGLISH, { mode: "prefix-all" });
+// Повертає: { prefix: '', localePrefix: undefined }
+```
+
+```javascript codeFormat="commonjs"
+const { getPrefix, Locales } = require("intlayer");
+
+getPrefix(Locales.ENGLISH, { mode: "prefix-all" });
+// Повертає: { prefix: '', localePrefix: undefined }
+```
+
+### Різні режими маршрутизації
+
+```typescript
+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 }
+```
+
+### Практичний приклад
+
+```typescript
+import { getPrefix, Locales } from "intlayer";
+
+// Формуємо URL з відповідним префіксом для конкретної локалі
+const locale = Locales.FRENCH;
+const { prefix, localePrefix } = getPrefix(locale, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+
+// Використання prefix для побудови шляху
+const url1 = `/${prefix}about`.replace(/\/+/g, "/");
+// Результат: "/fr/about"
+
+// Використання localePrefix для ідентифікації локалі
+console.log(`Current locale: ${localePrefix}`);
+// Вивід: "Current locale: fr"
+```
+
+---
+
+## Пов'язані функції
+
+- [`getLocalizedUrl`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/packages/intlayer/getLocalizedUrl.md): Генерує локалізований URL для певної локалі
+- [`getMultilingualUrls`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/packages/intlayer/getMultilingualUrls.md): Генерує URL-адреси для всіх налаштованих локалей
+
+---
+
+## TypeScript
+
+```typescript
+type GetPrefixResult = {
+  prefix: string; // Префікс шляху з кінцевим слешем (наприклад, 'fr/' або '')
+  localePrefix?: Locale; // Ідентифікатор локалі без слешів (наприклад, 'fr' або undefined)
+};
+
+function getPrefix(
+  locale: Locales,
+  options?: {
+    defaultLocale?: Locales;
+    mode?: "prefix-no-default" | "prefix-all" | "no-prefix" | "search-params";
+  }
+): GetPrefixResult;
+```