Add jsdoc to LangHelper.ts and customHooks.ts

aelassas · Sep 24, 2023 · a393ade · a393ade
1 parent b16c93f
commit a393ade
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/backend/src/common/LangHelper.ts b/backend/src/common/LangHelper.ts
@@ -2,6 +2,11 @@ import { LocalizedStrings } from 'react-localization'
 import Env from '../config/env.config'
 import * as UserService from '../services/UserService'
 
+/**
+ * Get current language.
+ *
+ * @returns {string}
+ */
 export const getLanguage = () => {
   let language = UserService.getQueryLanguage() ?? ''
 
@@ -12,6 +17,12 @@ export const getLanguage = () => {
   return language
 }
 
+/**
+ * Set LocalizedStrings language.
+ *
+ * @param {LocalizedStrings<any>} strings
+ * @param {?string} [language]
+ */
 export const setLanguage = (strings: LocalizedStrings<any>, language?: string) => {
   const lang = language || getLanguage()
   strings.setLanguage(lang)

diff --git a/backend/src/common/customHooks.ts b/backend/src/common/customHooks.ts
@@ -1,5 +1,12 @@
 import { useState, useEffect } from 'react'
 
+/**
+ * Custom initialization hook.
+ *
+ * @param {*} callback
+ * @param {...*} args
+ * @returns {{}}
+ */
 export const useInit = (callback: any, ...args: any) => {
   const [mounted, setMounted] = useState(false)
 

diff --git a/frontend/src/common/LangHelper.ts b/frontend/src/common/LangHelper.ts
@@ -2,6 +2,11 @@ import { LocalizedStrings } from 'react-localization'
 import Env from '../config/env.config'
 import * as UserService from '../services/UserService'
 
+/**
+ * Get current language.
+ *
+ * @returns {string}
+ */
 export const getLanguage = () => {
   let language = UserService.getQueryLanguage() ?? ''
 
@@ -12,6 +17,12 @@ export const getLanguage = () => {
   return language
 }
 
+/**
+ * Set LocalizedStrings language.
+ *
+ * @param {LocalizedStrings<any>} strings
+ * @param {?string} [language]
+ */
 export const setLanguage = (strings: LocalizedStrings<any>, language?: string) => {
   const lang = language || getLanguage()
   strings.setLanguage(lang)

diff --git a/frontend/src/common/customHooks.ts b/frontend/src/common/customHooks.ts
@@ -1,5 +1,12 @@
 import { useState, useEffect } from 'react'
 
+/**
+ * Custom initialization hook.
+ *
+ * @param {*} callback
+ * @param {...*} args
+ * @returns {{}}
+ */
 export const useInit = (callback: any, ...args: any) => {
   const [mounted, setMounted] = useState(false)