generaltranslation 6.1.10 → 6.2.0

package/dist/index.d.ts

@@ -27,7 +27,7 @@ declare class GT {
      * @param {string} [params.projectId=''] - The project ID for the translation service.
      * @param {string} [params.baseUrl='https://api.gtx.dev'] - The base URL for the translation service.
      */
-    constructor({ apiKey, devApiKey, sourceLocale, projectId, baseUrl }?: GTConstructorParams);
+    constructor({ apiKey, devApiKey, sourceLocale, projectId, baseUrl, }?: GTConstructorParams);
     /**
      * Translates a string or an array of strings/variables into a target locale.
      * If `metadata.save` is provided, the translation is cached for use in a public project.
@@ -48,15 +48,15 @@ declare class GT {
         [key: string]: any;
     }): Promise<ContentTranslationResult | TranslationError>;
     /**
-    * Translates JSX elements into a given locale.
-    *
-    * @param {Object} params - The parameters for the translation.
-    * @param {JsxChildren} params.source - The JSX children content to be translated.
-    * @param {string} params.locale - The target locale for the translation.
-    * @param {Object} params.metadata - Additional metadata for the translation process.
-    *
-    * @returns {Promise<JsxTranslationResult | TranslationError>} - A promise that resolves to the translated content.
-    */
+     * Translates JSX elements into a given locale.
+     *
+     * @param {Object} params - The parameters for the translation.
+     * @param {JsxChildren} params.source - The JSX children content to be translated.
+     * @param {string} params.locale - The target locale for the translation.
+     * @param {Object} params.metadata - Additional metadata for the translation process.
+     *
+     * @returns {Promise<JsxTranslationResult | TranslationError>} - A promise that resolves to the translated content.
+     */
     translateJsx(source: JsxChildren, locale: string, metadata?: {
         context?: string;
         id?: string;
@@ -113,7 +113,7 @@ export declare function getLocaleName(locale: string, defaultLocale?: string): s
  * @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): {
     code: string;
     name: string;
@@ -144,7 +144,7 @@ export declare function getLocaleProperties(locale: string, defaultLocale?: stri
  * @param code - A string representing the locale code (e.g., 'en-US', 'fr-CA').
  * @param custom - An optional custom mapping of locale codes to emojis.
  * @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, custom?: Record<string, string>): string;
 /**
  * Checks if a given BCP 47 locale code is valid.
@@ -182,7 +182,7 @@ export declare function isSameDialect(...locales: (string | string[])[]): boolea
  *
  * @param {string[]} locales - The BCP 47 locale codes to compare.
  * @returns {boolean} True if all BCP 47 codes represent the same locale, false otherwise.
-*/
+ */
 export declare function isSameLanguage(...locales: (string | string[])[]): boolean;
 /**
  * Formats a number according to the specified locales and options.