Skip to content

Commit 389b76b

Browse files
#1425: Clarify JavaDoc
1 parent e27fc6d commit 389b76b

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

src/backend/src/utils/reimbursement-requests.utils.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,10 @@ export const isUserOnFinanceTeam = async (user: User): Promise<boolean> => {
245245
/**
246246
* Determines if a user is lead or head of the finance team.
247247
*
248+
* To be used for Prisma input validation of a plain User, as opposed to
249+
* <code>isAuthUserLeadForFinance</code>, which uses the additional fields
250+
* produced by authUserQueryArgs that are not in the User type by default.
251+
*
248252
* @param user the user to authenticate
249253
* @returns whether the user is lead or head of the finance team
250254
* @throws {HttpException} if finance team not found in database

0 commit comments

Comments
 (0)