From 4330fb2335c404515b757705a50a250b797c6624 Mon Sep 17 00:00:00 2001
From: Alberto Defendi <1369-ahl-berto@users.noreply.gitlab.inf.unibz.it>
Date: Thu, 27 May 2021 09:03:02 +0200
Subject: [PATCH] Start documentation.
---
src/components/Authorization/Authorization.tsx | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/src/components/Authorization/Authorization.tsx b/src/components/Authorization/Authorization.tsx
index 99762a2..5cf6d15 100644
--- a/src/components/Authorization/Authorization.tsx
+++ b/src/components/Authorization/Authorization.tsx
@@ -5,11 +5,17 @@ interface WithAuthProps {
allowedRoles: string[];
}
-export interface Props extends WithAuthProps {
+interface Props extends WithAuthProps {
children: React.ReactNode;
}
/* eslint-disable react/jsx-props-no-spreading */
+/**
+ *
+ * @param WrappedComponent component to be wrapped by the authentication control.
+ * This creates a "personal area" in the working implementation.
+ * @returns {FC<T>} wrapped component.
+ */
export const withAuthorization = <T extends WithAuthProps = WithAuthProps>(
WrappedComponent: React.ComponentType<T>,
): FC<T> => {
--
GitLab