jsdoc

leanstacks · Jul 2, 2024 · 75ff676 · 75ff676
1 parent 4e92406
commit 75ff676
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/src/pages/Users/api/useGetUser.ts b/src/pages/Users/api/useGetUser.ts
@@ -5,10 +5,19 @@ import { useConfig } from 'common/hooks/useConfig';
 import { User } from 'common/models/user';
 import { QueryKey } from 'common/utils/constants';
 
+/**
+ * Properties for the `useGetUser` API hook.
+ * @param {string} userId - A `User` identifier.
+ */
 interface UseGetUserProps {
   userId: string;
 }
 
+/**
+ * An API hook which fetches a single `User` object.
+ * @param {UseGetUserProps} props - Hook properties.
+ * @returns Returns a `UseQueryResult` with `User` data.
+ */
 export const useGetUser = ({ userId }: UseGetUserProps) => {
   const config = useConfig();
 

diff --git a/src/pages/Users/api/useGetUsers.ts b/src/pages/Users/api/useGetUsers.ts
@@ -5,6 +5,10 @@ import { useConfig } from 'common/hooks/useConfig';
 import { User } from 'common/models/user';
 import { QueryKey } from 'common/utils/constants';
 
+/**
+ * An API hook which fetches a collection of `User` objects.
+ * @returns Returns a `UseQueryResult` with `User` collection data.
+ */
 export const useGetUsers = () => {
   const config = useConfig();