@cesdk/cesdk-js 1.59.0-rc.0 → 1.59.1-rc.0

package/index.d.ts

@@ -2037,6 +2037,32 @@ export declare class InternationalizationAPI {
      * @returns An object mapping locale strings to their respective translations.
      */
     getTranslations(locales?: LocaleKey[]): Partial<Record<LocaleKey, Partial<Translations>>>;
+    /**
+     * Translates a key or array of keys to the current locale.
+     *
+     * This method retrieves the translation for the given key(s) in the currently
+     * active locale. When an array of keys is provided, the first key that has a
+     * translation will be used. If no translation is found for any of the provided
+     * keys, the last key in the array (or the single key if a string is provided)
+     * will be returned as the fallback value.
+     *
+     * @category Localization
+     * @param key - A translation key string or an array of translation keys to try in order.
+     * @returns The translated string for the key in the current locale, or the key itself if no translation is found.
+     *
+     * @example
+     * ```
+     * // Single key
+     * const translation = cesdk.i18n.translate('common.save');
+     * // Returns: "Save" (if translation exists) or "common.save" (if not found)
+     *
+     * // Array of keys (fallback)
+     * const translation = cesdk.i18n.translate(['specific.save', 'common.save']);
+     * // Tries 'specific.save' first, then 'common.save'
+     * // Returns the first found translation or "common.save" if neither exists
+     * ```
+     */
+    translate(key: string | string[]): string;
 }
 
 /**