generaltranslation 7.0.0-alpha.2 → 7.0.0-alpha.20

package/dist/index.d.ts

@@ -36,7 +36,7 @@ type GTConstructorParams = {
  *   locales: ['en-US', 'es-ES', 'fr-FR']
  * });
  */
-export default class GT {
+export declare class GT {
     /** Base URL for the translation service API */
     baseUrl: string;
     /** Project ID for the translation service */
@@ -89,7 +89,7 @@ export default class GT {
      * // Returns: "Bonjour John"
      */
     formatMessage(message: string, options?: {
-        locales?: string[];
+        locales?: string | string[];
         variables?: FormatVariables;
     }): string;
     /**
@@ -97,7 +97,7 @@ export default class GT {
      *
      * @param {number} number - The number to format
      * @param {Object} [options] - Additional options for number formatting
-     * @param {string[]} [options.locales] - The locales to use for formatting
+     * @param {string | string[]} [options.locales] - The locales to use for formatting
      * @param {Intl.NumberFormatOptions} [options] - Additional Intl.NumberFormat options
      * @returns {string} The formatted number
      *
@@ -106,14 +106,14 @@ export default class GT {
      * // Returns: "$1,234.56"
      */
     formatNum(number: number, options?: {
-        locales?: string[];
+        locales?: string | string[];
     } & Intl.NumberFormatOptions): string;
     /**
      * Formats a date according to the specified locales and options.
      *
      * @param {Date} date - The date to format
      * @param {Object} [options] - Additional options for date formatting
-     * @param {string[]} [options.locales] - The locales to use for formatting
+     * @param {string | string[]} [options.locales] - The locales to use for formatting
      * @param {Intl.DateTimeFormatOptions} [options] - Additional Intl.DateTimeFormat options
      * @returns {string} The formatted date
      *
@@ -122,7 +122,7 @@ export default class GT {
      * // Returns: "Thursday, March 14, 2024 at 2:30:45 PM GMT-7"
      */
     formatDateTime(date: Date, options?: {
-        locales?: string[];
+        locales?: string | string[];
     } & Intl.DateTimeFormatOptions): string;
     /**
      * Formats a currency value according to the specified locales and options.
@@ -130,7 +130,7 @@ export default class GT {
      * @param {number} value - The currency value to format
      * @param {string} currency - The currency code (e.g., 'USD', 'EUR')
      * @param {Object} [options] - Additional options for currency formatting
-     * @param {string[]} [options.locales] - The locales to use for formatting
+     * @param {string | string[]} [options.locales] - The locales to use for formatting
      * @param {Intl.NumberFormatOptions} [options] - Additional Intl.NumberFormat options
      * @returns {string} The formatted currency value
      *
@@ -139,14 +139,14 @@ export default class GT {
      * // Returns: "$1,234.56"
      */
     formatCurrency(value: number, currency: string, options?: {
-        locales?: string[];
+        locales?: string | string[];
     } & Intl.NumberFormatOptions): string;
     /**
      * Formats a list of items according to the specified locales and options.
      *
      * @param {Array<string | number>} array - The list of items to format
      * @param {Object} [options] - Additional options for list formatting
-     * @param {string[]} [options.locales] - The locales to use for formatting
+     * @param {string | string[]} [options.locales] - The locales to use for formatting
      * @param {Intl.ListFormatOptions} [options] - Additional Intl.ListFormat options
      * @returns {string} The formatted list
      *
@@ -155,7 +155,7 @@ export default class GT {
      * // Returns: "apple, banana, and orange"
      */
     formatList(array: Array<string | number>, options?: {
-        locales?: string[];
+        locales?: string | string[];
     } & Intl.ListFormatOptions): string;
     /**
      * Formats a relative time value according to the specified locales and options.
@@ -163,7 +163,7 @@ export default class GT {
      * @param {number} value - The relative time value to format
      * @param {Intl.RelativeTimeFormatUnit} unit - The unit of time (e.g., 'second', 'minute', 'hour', 'day', 'week', 'month', 'year')
      * @param {Object} options - Additional options for relative time formatting
-     * @param {string[]} [options.locales] - The locales to use for formatting
+     * @param {string | string[]} [options.locales] - The locales to use for formatting
      * @param {Intl.RelativeTimeFormatOptions} [options] - Additional Intl.RelativeTimeFormat options
      * @returns {string} The formatted relative time string
      *
@@ -172,7 +172,7 @@ export default class GT {
      * // Returns: "yesterday"
      */
     formatRelativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options?: {
-        locales?: string[];
+        locales?: string | string[];
     } & Omit<Intl.RelativeTimeFormatOptions, 'locales'>): string;
     /**
      * Retrieves the display name of a locale code using Intl.DisplayNames.
@@ -199,16 +199,6 @@ export default class GT {
      * // Returns: "🇪🇸"
      */
     getLocaleEmoji(locale?: string | undefined): string;
-    /**
-     * Retrieves an emoji based on a given locale code, taking into account region, language, and specific exceptions.
-     *
-     * This function uses the locale's region (if present) to select an emoji or falls back on default emojis for certain languages.
-     *
-     * @param locale - A string representing the locale code (e.g., 'en-US', 'fr-CA').
-     * @param {CustomMapping} [customMapping] - A custom mapping of locale codes to their names.
-     * @returns The emoji representing the locale or its region, or a default emoji if no specific match is found.
-     */
-    static getLocaleEmoji(locale: string, customMapping?: CustomMapping): string;
     /**
      * Generates linguistic details for a given locale code.
      *
@@ -345,172 +335,197 @@ export default class GT {
      * // Returns: false
      */
     isSupersetLocale(superLocale: string, subLocale: string): boolean;
-    static formatMessage(message: string, options?: {
-        locales?: string[];
-        variables?: FormatVariables;
-    }): string;
-    /**
-     * Formats a number according to the specified locales and options.
-     * @param {Object} params - The parameters for the number formatting.
-     * @param {number} params.value - The number to format.
-     * @param {Intl.NumberFormatOptions} [params.options] - Additional options for number formatting.
-     * @param {string[]} [params.options.locales] - The locales to use for formatting.
-     * @returns {string} The formatted number.
-     */
-    static formatNum(number: number, options: {
-        locales: string[];
-    } & Intl.NumberFormatOptions): string;
-    /**
-     * Formats a date according to the specified languages and options.
-     * @param {Object} params - The parameters for the date formatting.
-     * @param {Date} params.value - The date to format.
-     * @param {Intl.DateTimeFormatOptions} [params.options] - Additional options for date formatting.
-     * @param {string[]} [params.options.locales] - The languages to use for formatting.
-     * @returns {string} The formatted date.
-     */
-    static formatDateTime(date: Date, options?: {
-        locales?: string[];
-    } & Intl.DateTimeFormatOptions): string;
-    /**
-     * Formats a currency value according to the specified languages, currency, and options.
-     * @param {Object} params - The parameters for the currency formatting.
-     * @param {number} params.value - The currency value to format.
-     * @param {string} params.currency - The currency code (e.g., 'USD').
-     * @param {Intl.NumberFormatOptions} [params.options={}] - Additional options for currency formatting.
-     * @param {string[]} [params.options.locales] - The locale codes to use for formatting.
-     * @returns {string} The formatted currency value.
-     */
-    static formatCurrency(value: number, currency: string, options: {
-        locales: string[];
-    } & Intl.NumberFormatOptions): string;
-    /**
-     * Formats a list of items according to the specified locales and options.
-     * @param {Object} params - The parameters for the list formatting.
-     * @param {Array<string | number>} params.value - The list of items to format.
-     * @param {Intl.ListFormatOptions} [params.options={}] - Additional options for list formatting.
-     * @param {string[]} [params.options.locales] - The locales to use for formatting.
-     * @returns {string} The formatted list.
-     */
-    static formatList(array: Array<string | number>, options: {
-        locales: string[];
-    } & Intl.ListFormatOptions): string;
-    /**
-     * Formats a relative time value according to the specified locales and options.
-     * @param {Object} params - The parameters for the relative time formatting.
-     * @param {number} params.value - The relative time value to format.
-     * @param {Intl.RelativeTimeFormatUnit} params.unit - The unit of time (e.g., 'second', 'minute', 'hour', 'day', 'week', 'month', 'year').
-     * @param {Intl.RelativeTimeFormatOptions} [params.options={}] - Additional options for relative time formatting.
-     * @param {string[]} [params.options.locales] - The locales to use for formatting.
-     * @returns {string} The formatted relative time string.
-     */
-    static formatRelativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options: {
-        locales: string[];
-    } & Omit<Intl.RelativeTimeFormatOptions, 'locales'>): string;
-    /**
-     * Retrieves the display name of locale code using Intl.DisplayNames.
-     *
-     * @param {string} locale - A BCP-47 locale code.
-     * @param {string} [defaultLocale] - The default locale to use for formatting.
-     * @param {CustomMapping} [customMapping] - A custom mapping of locale codes to their names.
-     * @returns {string} The display name corresponding to the code.
-     */
-    static getLocaleName(locale: string, defaultLocale?: string, customMapping?: CustomMapping): string;
-    /**
-     * Generates linguistic details for a given locale code.
-     *
-     * This function returns information about the locale,
-     * script, and region of a given language code both in a standard form and in a maximized form (with likely script and region).
-     * The function provides these names in both your default language and native forms, and an associated emoji.
-     *
-     * @param {string} locale - The locale code to get properties for (e.g., "de-AT").
-     * @param {string} [defaultLocale] - The default locale to use for formatting.
-     * @param {CustomMapping} [customMapping] - A custom mapping of locale codes to their names.
-     * @returns {LocaleProperties} - An object containing detailed information about the locale.
-     *
-     * @property {string} code - The full locale code, e.g., "de-AT".
-     * @property {string} name - Language name in the default display language, e.g., "Austrian German".
-     * @property {string} nativeName - Language name in the locale's native language, e.g., "Österreichisches Deutsch".
-     * @property {string} languageCode - The base language code, e.g., "de".
-     * @property {string} languageName - The language name in the default display language, e.g., "German".
-     * @property {string} nativeLanguageName - The language name in the native language, e.g., "Deutsch".
-     * @property {string} nameWithRegionCode - Language name with region in the default language, e.g., "German (AT)".
-     * @property {string} nativeNameWithRegionCode - Language name with region in the native language, e.g., "Deutsch (AT)".
-     * @property {string} regionCode - The region code from maximization, e.g., "AT".
-     * @property {string} regionName - The region name in the default display language, e.g., "Austria".
-     * @property {string} nativeRegionName - The region name in the native language, e.g., "Österreich".
-     * @property {string} scriptCode - The script code from maximization, e.g., "Latn".
-     * @property {string} scriptName - The script name in the default display language, e.g., "Latin".
-     * @property {string} nativeScriptName - The script name in the native language, e.g., "Lateinisch".
-     * @property {string} maximizedCode - The maximized locale code, e.g., "de-Latn-AT".
-     * @property {string} maximizedName - Maximized locale name with likely script in the default language, e.g., "Austrian German (Latin)".
-     * @property {string} nativeMaximizedName - Maximized locale name in the native language, e.g., "Österreichisches Deutsch (Lateinisch)".
-     * @property {string} minimizedCode - Minimized locale code, e.g., "de-AT" (or "de" for "de-DE").
-     * @property {string} minimizedName - Minimized language name in the default language, e.g., "Austrian German".
-     * @property {string} nativeMinimizedName - Minimized language name in the native language, e.g., "Österreichisches Deutsch".
-     * @property {string} emoji - The emoji associated with the locale's region, if applicable.
-     */
-    static getLocaleProperties(locale: string, defaultLocale?: string, customMapping?: CustomMapping): LocaleProperties;
-    /**
-     * Determines whether a translation is required based on the source and target locales.
-     *
-     * - If the target locale is not specified, the function returns `false`, as translation is not needed.
-     * - If the source and target locale are the same, returns `false`, indicating that no translation is necessary.
-     * - If the `approvedLocales` array is provided, and the target locale is not within that array, the function also returns `false`.
-     * - Otherwise, it returns `true`, meaning that a translation is required.
-     *
-     * @param {string} sourceLocale - The locale code for the original content (BCP 47 locale code).
-     * @param {string} targetLocale - The locale code of the language to translate the content into (BCP 47 locale code).
-     * @param {string[]} [approvedLocale] - An optional array of approved target locales.
-     *
-     * @returns {boolean} - Returns `true` if translation is required, otherwise `false`.
-     */
-    static requiresTranslation(sourceLocale: string, targetLocale: string, approvedLocales?: string[]): boolean;
-    /**
-     * Determines the best matching locale from the provided approved locales list.
-     * @param {string | string[]} locales - A single locale or an array of locales sorted in preference order.
-     * @param {string[]} [approvedLocales=this.locales] - An array of approved locales, also sorted by preference.
-     * @returns {string | undefined} - The best matching locale from the approvedLocales list, or undefined if no match is found.
-     */
-    static determineLocale(locales: string | string[], approvedLocales?: string[] | undefined): string | undefined;
-    /**
-     * Get the text direction for a given locale code using the Intl.Locale API.
-     *
-     * @param {string} locale - A BCP-47 locale code.
-     * @returns {string} - 'rtl' if the locale is right-to-left, otherwise 'ltr'.
-     */
-    static getLocaleDirection(locale: string): 'ltr' | 'rtl';
-    /**
-     * Checks if a given BCP 47 locale code is valid.
-     * @param {string} locale - The BCP 47 locale code to validate.
-     * @returns {boolean} True if the BCP 47 code is valid, false otherwise.
-     */
-    static isValidLocale(locale: string): boolean;
-    /**
-     * Standardizes a BCP 47 locale code to ensure correct formatting.
-     * @param {string} locale - The BCP 47 locale code to standardize.
-     * @returns {string} The standardized BCP 47 locale code or an empty string if it is an invalid code.
-     */
-    static standardizeLocale(locale: string): string;
-    /**
-     * Checks if multiple BCP 47 locale codes represent the same dialect.
-     * @param {string[]} locales - The BCP 47 locale codes to compare.
-     * @returns {boolean} True if all BCP 47 codes represent the same dialect, false otherwise.
-     */
-    static isSameDialect(...locales: (string | string[])[]): boolean;
-    /**
-     * Checks if multiple BCP 47 locale codes represent the same language.
-     * @param {string[]} locales - The BCP 47 locale codes to compare.
-     * @returns {boolean} True if all BCP 47 codes represent the same language, false otherwise.
-     */
-    static isSameLanguage(...locales: (string | string[])[]): boolean;
-    /**
-     * Checks if a locale is a superset of another locale.
-     * A subLocale is a subset of superLocale if it is an extension of superLocale or are otherwise identical.
-     *
-     * @param {string} superLocale - The locale to check if it is a superset of the other locale.
-     * @param {string} subLocale - The locale to check if it is a subset of the other locale.
-     * @returns {boolean} True if the first locale is a superset of the second locale, false otherwise.
-     */
-    static isSupersetLocale(superLocale: string, subLocale: string): boolean;
 }
+/**
+ * Formats a message according to the specified locales and options.
+ *
+ * @param {string} message - The message to format.
+ * @param {string | string[]} [locales='en'] - The locales to use for formatting.
+ * @param {FormatVariables} [variables={}] - The variables to use for formatting.
+ * @returns {string} The formatted message.
+ *
+ * @example
+ * formatMessage('Hello {name}', { name: 'John' });
+ * // Returns: "Hello John"
+ *
+ * formatMessage('Hello {name}', { name: 'John' }, { locales: ['fr'] });
+ * // Returns: "Bonjour John"
+ */
+export declare function formatMessage(message: string, options?: {
+    locales?: string | string[];
+    variables?: FormatVariables;
+}): string;
+/**
+ * Formats a number according to the specified locales and options.
+ * @param {Object} params - The parameters for the number formatting.
+ * @param {number} params.value - The number to format.
+ * @param {Intl.NumberFormatOptions} [params.options] - Additional options for number formatting.
+ * @param {string | string[]} [params.options.locales] - The locales to use for formatting.
+ * @returns {string} The formatted number.
+ */
+export declare function formatNum(number: number, options: {
+    locales: string | string[];
+} & Intl.NumberFormatOptions): string;
+/**
+ * Formats a date according to the specified languages and options.
+ * @param {Object} params - The parameters for the date formatting.
+ * @param {Date} params.value - The date to format.
+ * @param {Intl.DateTimeFormatOptions} [params.options] - Additional options for date formatting.
+ * @param {string | string[]} [params.options.locales] - The languages to use for formatting.
+ * @returns {string} The formatted date.
+ */
+export declare function formatDateTime(date: Date, options?: {
+    locales?: string | string[];
+} & Intl.DateTimeFormatOptions): string;
+/**
+ * Formats a currency value according to the specified languages, currency, and options.
+ * @param {Object} params - The parameters for the currency formatting.
+ * @param {number} params.value - The currency value to format.
+ * @param {string} params.currency - The currency code (e.g., 'USD').
+ * @param {Intl.NumberFormatOptions} [params.options={}] - Additional options for currency formatting.
+ * @param {string | string[]} [params.options.locales] - The locale codes to use for formatting.
+ * @returns {string} The formatted currency value.
+ */
+export declare function formatCurrency(value: number, currency: string, options: {
+    locales: string | string[];
+} & Intl.NumberFormatOptions): string;
+/**
+ * Formats a list of items according to the specified locales and options.
+ * @param {Object} params - The parameters for the list formatting.
+ * @param {Array<string | number>} params.value - The list of items to format.
+ * @param {Intl.ListFormatOptions} [params.options={}] - Additional options for list formatting.
+ * @param {string | string[]} [params.options.locales] - The locales to use for formatting.
+ * @returns {string} The formatted list.
+ */
+export declare function formatList(array: Array<string | number>, options: {
+    locales: string | string[];
+} & Intl.ListFormatOptions): string;
+/**
+ * Formats a relative time value according to the specified locales and options.
+ * @param {Object} params - The parameters for the relative time formatting.
+ * @param {number} params.value - The relative time value to format.
+ * @param {Intl.RelativeTimeFormatUnit} params.unit - The unit of time (e.g., 'second', 'minute', 'hour', 'day', 'week', 'month', 'year').
+ * @param {Intl.RelativeTimeFormatOptions} [params.options={}] - Additional options for relative time formatting.
+ * @param {string | string[]} [params.options.locales] - The locales to use for formatting.
+ * @returns {string} The formatted relative time string.
+ */
+export declare function formatRelativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options: {
+    locales: string | string[];
+} & Omit<Intl.RelativeTimeFormatOptions, 'locales'>): string;
+/**
+ * Retrieves the display name of locale code using Intl.DisplayNames.
+ *
+ * @param {string} locale - A BCP-47 locale code.
+ * @param {string} [defaultLocale] - The default locale to use for formatting.
+ * @param {CustomMapping} [customMapping] - A custom mapping of locale codes to their names.
+ * @returns {string} The display name corresponding to the code.
+ */
+export declare function getLocaleName(locale: string, defaultLocale?: string, customMapping?: CustomMapping): string;
+/**
+ * Retrieves an emoji based on a given locale code, taking into account region, language, and specific exceptions.
+ *
+ * This function uses the locale's region (if present) to select an emoji or falls back on default emojis for certain languages.
+ *
+ * @param locale - A string representing the locale code (e.g., 'en-US', 'fr-CA').
+ * @param {CustomMapping} [customMapping] - A custom mapping of locale codes to their names.
+ * @returns The emoji representing the locale or its region, or a default emoji if no specific match is found.
+ */
+export declare function getLocaleEmoji(locale: string, customMapping?: CustomMapping): string;
+/**
+ * Generates linguistic details for a given locale code.
+ *
+ * This function returns information about the locale,
+ * script, and region of a given language code both in a standard form and in a maximized form (with likely script and region).
+ * The function provides these names in both your default language and native forms, and an associated emoji.
+ *
+ * @param {string} locale - The locale code to get properties for (e.g., "de-AT").
+ * @param {string} [defaultLocale] - The default locale to use for formatting.
+ * @param {CustomMapping} [customMapping] - A custom mapping of locale codes to their names.
+ * @returns {LocaleProperties} - An object containing detailed information about the locale.
+ *
+ * @property {string} code - The full locale code, e.g., "de-AT".
+ * @property {string} name - Language name in the default display language, e.g., "Austrian German".
+ * @property {string} nativeName - Language name in the locale's native language, e.g., "Österreichisches Deutsch".
+ * @property {string} languageCode - The base language code, e.g., "de".
+ * @property {string} languageName - The language name in the default display language, e.g., "German".
+ * @property {string} nativeLanguageName - The language name in the native language, e.g., "Deutsch".
+ * @property {string} nameWithRegionCode - Language name with region in the default language, e.g., "German (AT)".
+ * @property {string} nativeNameWithRegionCode - Language name with region in the native language, e.g., "Deutsch (AT)".
+ * @property {string} regionCode - The region code from maximization, e.g., "AT".
+ * @property {string} regionName - The region name in the default display language, e.g., "Austria".
+ * @property {string} nativeRegionName - The region name in the native language, e.g., "Österreich".
+ * @property {string} scriptCode - The script code from maximization, e.g., "Latn".
+ * @property {string} scriptName - The script name in the default display language, e.g., "Latin".
+ * @property {string} nativeScriptName - The script name in the native language, e.g., "Lateinisch".
+ * @property {string} maximizedCode - The maximized locale code, e.g., "de-Latn-AT".
+ * @property {string} maximizedName - Maximized locale name with likely script in the default language, e.g., "Austrian German (Latin)".
+ * @property {string} nativeMaximizedName - Maximized locale name in the native language, e.g., "Österreichisches Deutsch (Lateinisch)".
+ * @property {string} minimizedCode - Minimized locale code, e.g., "de-AT" (or "de" for "de-DE").
+ * @property {string} minimizedName - Minimized language name in the default language, e.g., "Austrian German".
+ * @property {string} nativeMinimizedName - Minimized language name in the native language, e.g., "Österreichisches Deutsch".
+ * @property {string} emoji - The emoji associated with the locale's region, if applicable.
+ */
+export declare function getLocaleProperties(locale: string, defaultLocale?: string, customMapping?: CustomMapping): LocaleProperties;
+/**
+ * Determines whether a translation is required based on the source and target locales.
+ *
+ * - If the target locale is not specified, the function returns `false`, as translation is not needed.
+ * - If the source and target locale are the same, returns `false`, indicating that no translation is necessary.
+ * - If the `approvedLocales` array is provided, and the target locale is not within that array, the function also returns `false`.
+ * - Otherwise, it returns `true`, meaning that a translation is required.
+ *
+ * @param {string} sourceLocale - The locale code for the original content (BCP 47 locale code).
+ * @param {string} targetLocale - The locale code of the language to translate the content into (BCP 47 locale code).
+ * @param {string[]} [approvedLocale] - An optional array of approved target locales.
+ *
+ * @returns {boolean} - Returns `true` if translation is required, otherwise `false`.
+ */
+export declare function requiresTranslation(sourceLocale: string, targetLocale: string, approvedLocales?: string[]): boolean;
+/**
+ * Determines the best matching locale from the provided approved locales list.
+ * @param {string | string[]} locales - A single locale or an array of locales sorted in preference order.
+ * @param {string[]} [approvedLocales=this.locales] - An array of approved locales, also sorted by preference.
+ * @returns {string | undefined} - The best matching locale from the approvedLocales list, or undefined if no match is found.
+ */
+export declare function determineLocale(locales: string | string[], approvedLocales?: string[] | undefined): string | undefined;
+/**
+ * Get the text direction for a given locale code using the Intl.Locale API.
+ *
+ * @param {string} locale - A BCP-47 locale code.
+ * @returns {string} - 'rtl' if the locale is right-to-left, otherwise 'ltr'.
+ */
+export declare function getLocaleDirection(locale: string): 'ltr' | 'rtl';
+/**
+ * Checks if a given BCP 47 locale code is valid.
+ * @param {string} locale - The BCP 47 locale code to validate.
+ * @returns {boolean} True if the BCP 47 code is valid, false otherwise.
+ */
+export declare function isValidLocale(locale: string): boolean;
+/**
+ * Standardizes a BCP 47 locale code to ensure correct formatting.
+ * @param {string} locale - The BCP 47 locale code to standardize.
+ * @returns {string} The standardized BCP 47 locale code or an empty string if it is an invalid code.
+ */
+export declare function standardizeLocale(locale: string): string;
+/**
+ * Checks if multiple BCP 47 locale codes represent the same dialect.
+ * @param {string[]} locales - The BCP 47 locale codes to compare.
+ * @returns {boolean} True if all BCP 47 codes represent the same dialect, false otherwise.
+ */
+export declare function isSameDialect(...locales: (string | string[])[]): boolean;
+/**
+ * Checks if multiple BCP 47 locale codes represent the same language.
+ * @param {string[]} locales - The BCP 47 locale codes to compare.
+ * @returns {boolean} True if all BCP 47 codes represent the same language, false otherwise.
+ */
+export declare function isSameLanguage(...locales: (string | string[])[]): boolean;
+/**
+ * Checks if a locale is a superset of another locale.
+ * A subLocale is a subset of superLocale if it is an extension of superLocale or are otherwise identical.
+ *
+ * @param {string} superLocale - The locale to check if it is a superset of the other locale.
+ * @param {string} subLocale - The locale to check if it is a subset of the other locale.
+ * @returns {boolean} True if the first locale is a superset of the second locale, false otherwise.
+ */
+export declare function isSupersetLocale(superLocale: string, subLocale: string): boolean;
 export {};