chore: add jsdoc

deriv-com · Sep 18, 2024 · b7a0e80 · b7a0e80
1 parent b511b8b
commit b7a0e80
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/src/hooks/useIsOAuth2Enabled.ts b/src/hooks/useIsOAuth2Enabled.ts
@@ -5,6 +5,12 @@ type hydraBEApps = {
     enabled_for: number[];
 };
 
+/**
+ * Custom hook to determine whether OAuth2 is enabled for a given app id.
+ * @param {hydraBEApps[]} OAuth2EnabledApps - an array of Hydra enabled apps
+ * @param {boolean} OAuth2EnabledAppsInitialised - a flag indicating whether the array has been initialised
+ * @returns {boolean} - a boolean indicating whether OAuth2 is enabled for the current app id
+ */
 export const useIsOAuth2Enabled = (
     OAuth2EnabledApps: hydraBEApps[],
     OAuth2EnabledAppsInitialised: boolean

diff --git a/src/hooks/useOAuth2.ts b/src/hooks/useOAuth2.ts
@@ -19,7 +19,7 @@ type OAuth2Config = {
 /**
  * Custom hook to handle OAuth2 logout and redirection.
  *
- * @param {OAuth2Config} config - Configuration object containing OAuth2 enabled apps and initialisation flag.
+ * @param {OAuth2Config} config - Configuration object containing OAuth2 enabled apps flag and initialisation flag.
  * @param {(oauthUrl: string) => Promise<void>} WSLogoutAndRedirect - Function to handle logout and redirection.
  * @returns {{ OAuth2Logout: () => Promise<void> }} - Object containing the OAuth2Logout function.
  */