Update health-services/project-factory/src/server/utils/genericUtils.ts

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
egovernments · Jan 21, 2025 · e4cbbc4 · e4cbbc4
1 parent cdcec89
commit e4cbbc4
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/health-services/project-factory/src/server/utils/genericUtils.ts b/health-services/project-factory/src/server/utils/genericUtils.ts
@@ -1338,6 +1338,13 @@ async function getLocalizedMessagesHandlerViaRequestInfo(RequestInfo: any, tenan
   return localizationResponse;
 }
 
+/**
+ * Get localized messages using a specific locale
+ * @param locale The locale string to use for localization
+ * @param tenantId The tenant ID
+ * @param module The module name, defaults to config.localisation.localizationModule
+ * @returns Promise<Record<string, string>> A promise that resolves to localized messages
+ */
 async function getLocalizedMessagesHandlerViaLocale(locale:string, tenantId: any, module = config.localisation.localizationModule) {
   const localisationcontroller = Localisation.getInstance();
   const localizationResponse = await localisationcontroller.getLocalisedData(module, locale, tenantId);