generaltranslation 7.7.3 → 7.9.0

package/dist/index.d.ts

@@ -24,7 +24,7 @@ type LocaleProperties = {
     emoji: string;
 };
 
-type VariableType = 'v' | 'n' | 'd' | 'c';
+type VariableType = 'v' | 'n' | 'd' | 'c' | 's';
 /**
  * Variables are used to store the variable name and type.
  */
@@ -915,6 +915,21 @@ declare class GT {
     formatList(array: Array<string | number>, options?: {
         locales?: string | string[];
     } & Intl.ListFormatOptions): string;
+    /**
+     * Formats a list of items according to the specified locales and options.
+     * @param {Array<T>} array - The list of items to format
+     * @param {Object} [options] - Additional options for list formatting
+     * @param {string | string[]} [options.locales] - The locales to use for formatting
+     * @param {Intl.ListFormatOptions} [options] - Additional Intl.ListFormat options
+     * @returns {Array<T | string>} The formatted list parts
+     *
+     * @example
+     * gt.formatListToParts(['apple', 42, { foo: 'bar' }], { type: 'conjunction', style: 'short', locales: ['en'] });
+     * // Returns: ['apple', ', ', 42, ' and ', '{ foo: "bar" }']
+     */
+    formatListToParts<T>(array: Array<T>, options?: {
+        locales?: string | string[];
+    } & Intl.ListFormatOptions): Array<T | string>;
     /**
      * Formats a relative time value according to the specified locales and options.
      *
@@ -1215,6 +1230,17 @@ declare function formatCurrency(value: number, currency: string, options: {
 declare function formatList(array: Array<string | number>, options: {
     locales: string | string[];
 } & Intl.ListFormatOptions): string;
+/**
+ * Formats a list of items according to the specified locales and options.
+ * @param {Array<T>} array - The list of items to format
+ * @param {Object} [options] - Additional options for list formatting
+ * @param {string | string[]} [options.locales] - The locales to use for formatting
+ * @param {Intl.ListFormatOptions} [options] - Additional Intl.ListFormat options
+ * @returns {Array<T | string>} The formatted list parts
+ */
+declare function formatListToParts<T>(array: Array<T>, options?: {
+    locales?: string | string[];
+} & Intl.ListFormatOptions): Array<T | string>;
 /**
  * Formats a relative time value according to the specified locales and options.
  * @param {Object} params - The parameters for the relative time formatting.
@@ -1352,4 +1378,4 @@ declare function isSameLanguage(...locales: (string | string[])[]): boolean;
  */
 declare function isSupersetLocale(superLocale: string, subLocale: string): boolean;
 
-export { GT, determineLocale, formatCurrency, formatDateTime, formatList, formatMessage, formatNum, formatRelativeTime, getLocaleDirection, getLocaleEmoji, getLocaleName, getLocaleProperties, isSameDialect, isSameLanguage, isSupersetLocale, isValidLocale, requiresTranslation, resolveAliasLocale, standardizeLocale };
+export { GT, determineLocale, formatCurrency, formatDateTime, formatList, formatListToParts, formatMessage, formatNum, formatRelativeTime, getLocaleDirection, getLocaleEmoji, getLocaleName, getLocaleProperties, isSameDialect, isSameLanguage, isSupersetLocale, isValidLocale, requiresTranslation, resolveAliasLocale, standardizeLocale };