Add documentation to Team API

backend/src/API/teamAPI.ts

@@ -8,6 +8,12 @@ const membersDao = new MembersDao();
 
 export const allTeams = (): Promise<readonly Team[]> => MembersDao.getAllTeams();
 
+/**
+ * Updates a current team if exists, otherwise creates a new team. Adds the team to the
+ * subteams or formerSubteams field of any current members or former members, respectively.
+ * @param team - The Team object used to update team members.
+ * @returns - A promise that resolves when the update is complete.
+ */
 const updateTeamMembers = async (team: Team): Promise<void> => {
   const teamCopy = { ...team };
   teamCopy.uuid = teamCopy.uuid ? teamCopy.uuid : uuidv4();
@@ -25,6 +31,12 @@ const updateTeamMembers = async (team: Team): Promise<void> => {
   await updateFormerMembers(teamCopy, oldTeam);
 };
 
+/**
+ * Updates the subteams field of any new members or removed members of a team.
+ * @param team - The Team object that will be used to update current members.
+ * @param oldTeam - The Team object that represents the old team.
+ * @returns A promise that resolves when the update is complete.
+ */
 const updateCurrentMembers = async (team: Team, oldTeam: Team): Promise<void> => {
   let newMembers: IdolMember[] = [];
   let deletedMembers: IdolMember[] = [];
@@ -59,6 +71,12 @@ const updateCurrentMembers = async (team: Team, oldTeam: Team): Promise<void> =>
   );
 };
 
+/**
+ * Updates the formerSubteams field of any new former members or removed former members of a team.
+ * @param team - The Team object that will be used to update former members.
+ * @param oldTeam - The Team object that represents the old team.
+ * @returns A promise that resolves when the update is complete.
+ */
 const updateFormerMembers = async (team: Team, oldTeam: Team): Promise<void> => {
   let newFormerMembers: IdolMember[] = [];
   let removedFormerMembers: IdolMember[] = [];
@@ -92,6 +110,13 @@ const updateFormerMembers = async (team: Team, oldTeam: Team): Promise<void> =>
   );
 };
 
+/**
+ * Creates a team by adding the team to the subteam or formerSubteam field of all members or
+ * past members, respectively.
+ * @param teamBody - The Team object that will be created.
+ * @param member - The IdolMember that is requesting to set the team.
+ * @returns A promise that resolves to the created Team object.
+ */
 export const setTeam = async (teamBody: Team, member: IdolMember): Promise<Team> => {
   const canEdit = await PermissionsManager.canEditTeams(member);
   if (!canEdit) {
@@ -106,6 +131,13 @@ export const setTeam = async (teamBody: Team, member: IdolMember): Promise<Team>
   return teamBody;
 };
 
+/**
+ * Deletes a team by removing the team from the subteams or formerSubteams field of all members,
+ * leaders, and formerMembers of the team.
+ * @param teamBody - The Team object that will be deleted.
+ * @param member - The IdolMember that is requesting to delete the team.
+ * @returns A promise that resolves to the deleted Team object.
+ */
 export const deleteTeam = async (teamBody: Team, member: IdolMember): Promise<Team> => {
   if (!teamBody.uuid || teamBody.uuid === '') {
     throw new BadRequestError("Couldn't delete team with undefined uuid!");