#75 Added jsdoc for useRedirectTo.

artzub · Feb 3, 2022 · 7919ac5 · 7919ac5
1 parent 629036c
commit 7919ac5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/src/models/UrlPartTypes.js b/src/models/UrlPartTypes.js
@@ -1,3 +1,8 @@
+/**
+ * Types of url parts
+ * @readonly
+ * @enum {string}
+ */
 export const UrlPratTypes = {
   service: 'service',
   profile: 'profile',

diff --git a/src/shared/hooks/useRedirectTo.js b/src/shared/hooks/useRedirectTo.js
@@ -11,7 +11,11 @@ const order = [
   UrlPratTypes.commits,
 ];
 
-export const useRedirectTo = (partType) => {
+/**
+ * @param {UrlPratTypes} urlPartType
+ * @return {function(string): void}
+ */
+export const useRedirectTo = (urlPartType) => {
   const history = useHistory();
   const {
     service,
@@ -32,7 +36,7 @@ export const useRedirectTo = (partType) => {
 
   return useCallback(
     (part) => {
-      const index = order.indexOf(partType);
+      const index = order.indexOf(urlPartType);
       if (index < 0) {
         return;
       }
@@ -42,6 +46,6 @@ export const useRedirectTo = (partType) => {
 
       history.push(`${url}/${part}`);
     },
-    [hash, history, partType],
+    [hash, history, urlPartType],
   );
 };