refactor: add missing jsdoc for I18n class methods (#3153)

anuraghazra · Aug 27, 2023 · 20be439 · 20be439
1 parent eab5fc0
commit 20be439
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/common/I18n.js b/src/common/I18n.js
@@ -2,12 +2,25 @@
  * I18n translation class.
  */
 class I18n {
+  /**
+   * Constructor.
+   *
+   * @param {Object} options Options.
+   * @param {string} options.locale Locale.
+   * @param {Object} options.translations Translations.
+   */
   constructor({ locale, translations }) {
     this.locale = locale;
     this.translations = translations;
     this.fallbackLocale = "en";
   }
 
+  /**
+   * Get translation.
+   *
+   * @param {string} str String to translate.
+   * @returns {string} Translated string.
+   */
   t(str) {
     const locale = this.locale || this.fallbackLocale;