talawa-api / Exports / utilities/userFamilyAdminCheck
Module: utilities/userFamilyAdminCheck
Table of contents
Functions
Functions
adminCheck
▸ adminCheck(userId
, userFamily
): Promise
<void
>
If the current user is an admin of the organisation, this function returns true
otherwise it returns false
.
Parameters
Name | Type | Description |
---|---|---|
userId | string | ObjectId | Current user id. |
userFamily | InterfaceUserFamily | userFamily data of InterfaceuserFamily type. |
Returns
Promise
<void
>
True
or False
.
Remarks
This is a utility method.