STRF-9433: Update doc on cascade/flatten

bigcommerce · Jan 29, 2022 · c267e05 · c267e05
1 parent 717e60e
commit c267e05
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 31 deletions.
diff --git a/lib/translator/index.js b/lib/translator/index.js
@@ -39,7 +39,7 @@ function Translator(acceptLanguage, allTranslations, logger = console) {
 
     /**
      * @private
-     * @type {Object.<string, string>}
+     * @type {Object.<string, string|Object>}
      *
      * Looks like this:
      * {

diff --git a/lib/translator/transformer.js b/lib/translator/transformer.js
@@ -36,27 +36,25 @@
  *
  * The return value looks like this, assuming preferredLocales of ['fr-CA', 'en']:
  * {
- *   'fr-CA': {
- *     locale: 'fr-CA',
- *     locales: {
- *       'salutations.welcome': 'en',
- *       'salutations.hello': 'fr-CA',
- *       'salutations.bye': 'fr',
- *       items: 'en',
- *     },
- *     translations: {
- *       'salutations.welcome': 'Welcome',
- *       'salutations.hello': 'Salut {name}',
- *       'salutations.bye': 'au revoir',
- *       items: '{count, plural, one{1 Item} other{# Items}}',
- *     }
+ *   locale: 'fr-CA',
+ *   locales: {
+ *     'salutations.welcome': 'en',
+ *     'salutations.hello': 'fr-CA',
+ *     'salutations.bye': 'fr',
+ *     items: 'en',
  *   },
+ *   translations: {
+ *     'salutations.welcome': 'Welcome',
+ *     'salutations.hello': 'Salut {name}',
+ *     'salutations.bye': 'au revoir',
+ *     items: '{count, plural, one{1 Item} other{# Items}}',
+ *   }
  * }
  *
  * @param {Object.<string, Object>} allTranslations
  * @param {string[]} preferredLocales
  * @param {Object} logger
- * @returns {Object.<string, Object>} Transformed translations
+ * @returns {Object.<string, string|Object>} Transformed translations
  */
 function transform(allTranslations, preferredLocales, logger = console) {
     const flattened = flatten(allTranslations, preferredLocales, logger);
@@ -158,26 +156,24 @@ function flatten(translations, preferredLocales, logger = console) {
  *
  * The return value looks like this, assuming preferredLocales of ['fr-CA', 'en']:
  * {
- *   'fr-CA': {
- *     locale: 'fr-CA',
- *     locales: {
- *       'salutations.welcome': 'en',
- *       'salutations.hello': 'fr-CA',
- *       'salutations.bye': 'fr',
- *       items: 'en',
- *     },
- *     translations: {
- *       'salutations.welcome': 'Welcome',
- *       'salutations.hello': 'Salut {name}',
- *       'salutations.bye': 'au revoir',
- *       items: '{count, plural, one{1 Item} other{# Items}}',
- *     }
+ *   locale: 'fr-CA',
+ *   locales: {
+ *     'salutations.welcome': 'en',
+ *     'salutations.hello': 'fr-CA',
+ *     'salutations.bye': 'fr',
+ *     items: 'en',
  *   },
+ *   translations: {
+ *     'salutations.welcome': 'Welcome',
+ *     'salutations.hello': 'Salut {name}',
+ *     'salutations.bye': 'au revoir',
+ *     items: '{count, plural, one{1 Item} other{# Items}}',
+ *   }
  * }
  *
  * @param {Object.<string, Object>} translations Flattened translations
  * @param {string[]} preferredLocales Ordered list of preferred locales
- * @returns {Object.<string, Object>} Cascaded translations spec
+ * @returns {Object.<string, string|Object>} Cascaded translations spec
  */
 function cascade(translations, preferredLocales) {
     const result = { locale: preferredLocales[0], locales: {}, translations: {} };