reslib 2.0.2 → 2.1.0

package/build/types/i18n.d.ts

@@ -1,121 +0,0 @@
-import { Dictionary } from './dictionary';
-/**
- * @interface I18nTranslation
- * Represents a dictionary for internationalization (i18n) strings.
- *
- * This interface defines a structure for storing localized strings
- * for different locales. Each locale can have multiple keys, each
- * associated with a string or another dictionary for nested translations.
- *
- * @example
- * const translations: I18nTranslation = {
- *     en: {
- *         greeting: "Hello",
- *         farewell: "Goodbye",
- *         nested: {
-                example: "This is a nested translation.",
- *         }
- *     },
- *     es: {
- *         greeting: "Hola",
- *         farewell: "Adiós"
- *     }
- * };
- */
-export interface I18nTranslation extends Dictionary {
-}
-/**
- * Represents the different events related to internationalization (i18n).
- *
- * This type defines the possible events that can be emitted during
- * the i18n process, allowing for event-driven updates in the application.
- *
- * @example
- * function onI18nEvent(event: I18nEvent) {
- *     switch (event) {
- *         case "translations-loaded":
- *             console.log("Translation dictionary has been loaded.");
- *             break;
- *         case "translations-changed":
- *             console.log("Translation dictionary has been updated.");
- *             break;
- *         case "locale-changed":
- *             console.log("Locale has been changed.");
- *             break;
- *     }
- * }
- */
-export type I18nEvent = 'translations-loaded' | 'translations-changed' | 'locale-changed' | 'namespaces-before-load' | 'namespace-loaded' | 'namespaces-loaded';
-/**
- * A formatter function for internationalization (i18n) strings.
- *
- * This type defines a function that takes a string value and optional
- * parameters to format the string according to specific rules or
- * requirements. The formatted string is then returned.
- *
- * @param {string} value - The string value to format.
- * @param {Record<string, any>} [params] - Optional parameters to customize the formatting.
- * @returns {string} The formatted string.
- *
- * @example
- * const formatter: I18nFormatter = (value, params) => {
- *     return value.replace(/{(\w+)}/g, (_, key) => params[key] || '');
- * };
- *
- * const greeting = formatter("Hello, {name}!", { name: "John" }); // "Hello, John!"
- */
-export type I18nFormatter = (value: string, params?: Dictionary) => string;
-/**
- * @interface I18nOptions
- * Options for configuring internationalization (i18n) settings.
- *
- * This interface defines the options that can be used to customize
- * the behavior of the i18n system, including the locale, fallback
- * locale, and a custom formatter for string values.
- *
- * @property {string} locale - The primary locale to use for translations.
- * @property {string} [fallbackLocale] - An optional fallback locale to use if the primary locale is not available.
- * @property {I18nFormatter} [formatter] - An optional custom formatter function for formatting strings.
- *
- * @example
- * const i18nOptions: I18nOptions = {
- *     locale: "en",
- *     fallbackLocale: "es",
- *     formatter: (value, params) => value.replace(/{(\w+)}/g, (_, key) => params[key] || '')
- * };
- */
-export interface I18nOptions {
-    /**
-     * The primary locale to use for translations.
-     *
-     * @type {string}
-     * @example
-     * const currentLocale = i18nOptions.locale; // "en"
-     */
-    locale: string;
-    /**
-     * An optional fallback locale to use if the primary locale is not available.
-     *
-     * @type {string}
-     * @example
-     * const fallback = i18nOptions.fallbackLocale; // "es"
-     */
-    fallbackLocale?: string;
-    /**
-       * An optional custom formatter function for formatting strings.
-       *
-       * @type {I18nFormatter}
-       * @example
-       * const formattedString = i18nOptions.formatter("Hello, {name}!", { name: "Alice" });
-       * // Outputs: "Hello, Alice!"
-      ```typescript
-      *
-      * @example
-      * const i18nOptions: I18nOptions = {
-      *     locale: "en",
-      *     fallbackLocale: "es",
-      *     formatter: (value, params) => value.replace(/{(\w+)}/g, (_, key) => params[key] || '')
-      * };
-      */
-    formatter?: I18nFormatter;
-}